From ac46f0af059d12947013b18442fab59eae612adb Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 13:29:54 +0200 Subject: [PATCH 01/13] set parent properties and grandparents --- generator/PackageGenerator.php | 3 +- generator/Type.php | 53 ++++++++++++++++++++++++++++++++-- 2 files changed, 53 insertions(+), 3 deletions(-) diff --git a/generator/PackageGenerator.php b/generator/PackageGenerator.php index 3a2ce70f3..ef17819f8 100644 --- a/generator/PackageGenerator.php +++ b/generator/PackageGenerator.php @@ -17,7 +17,8 @@ public function generate(Definitions $definitions) $filesystem->cloneStaticFiles(); - $types->each(function (Type $type) use ($filesystem) { + $types->each(function (Type $type) use ($filesystem, $types) { + $type->setTypeCollection($types); $filesystem->createType($type); }); diff --git a/generator/Type.php b/generator/Type.php index c81cceda5..cc96e0029 100644 --- a/generator/Type.php +++ b/generator/Type.php @@ -7,15 +7,21 @@ class Type /** @var string */ public $name; - /** @var array */ + /** @var string[] */ public $parents = []; + /** @var string[] */ + public $grandParents = []; + /** @var string */ public $description; - /** @var array */ + /** @var Property[] */ public $properties = []; + /** @var Property[] */ + public $parentProperties; + /** @var array */ public $constants = []; @@ -35,4 +41,47 @@ public function addConstant(Constant $constant) ksort($this->constants); } + + public function setTypeCollection(TypeCollection $typeCollection): void + { + if($this->parentProperties !== null) { + return; + } + + $this->parentProperties = []; + + if(empty($this->parents)) { + return; + } + + $types = $typeCollection->toArray(); + + foreach($this->parents as $parent) { + if(!isset($types[$parent])) { + continue; + } + + /** @var Type $parent */ + $parent = $types[$parent]; + $parent->setTypeCollection($typeCollection); + + $this->grandParents = array_merge($parent->parents, $parent->grandParents); + + foreach($parent->properties as $property) { + if(isset($this->parentProperties[$property->name])) { + continue; + } + + $this->parentProperties[$property->name] = $property; + } + + foreach($parent->parentProperties as $parentProperty) { + if(isset($this->parentProperties[$parentProperty->name])) { + continue; + } + + $this->parentProperties[$parentProperty->name] = $parentProperty; + } + } + } } From cb3187a64eb94cb66d81cdf2932383fd6cf783d7 Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 13:30:29 +0200 Subject: [PATCH 02/13] add contract template --- generator/templates/twig/Contract.php.twig | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 generator/templates/twig/Contract.php.twig diff --git a/generator/templates/twig/Contract.php.twig b/generator/templates/twig/Contract.php.twig new file mode 100644 index 000000000..c20656949 --- /dev/null +++ b/generator/templates/twig/Contract.php.twig @@ -0,0 +1,15 @@ + Date: Tue, 17 Sep 2019 13:30:40 +0200 Subject: [PATCH 03/13] add contract renderer --- generator/Writer/Filesystem.php | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/generator/Writer/Filesystem.php b/generator/Writer/Filesystem.php index 09fce05d7..dc36dc491 100644 --- a/generator/Writer/Filesystem.php +++ b/generator/Writer/Filesystem.php @@ -12,14 +12,21 @@ class Filesystem /** @var \League\Flysystem\Filesystem */ protected $flysystem; + /** @var \Spatie\SchemaOrg\Generator\Writer\Template */ + protected $contractTemplate; + /** @var \Spatie\SchemaOrg\Generator\Writer\Template */ protected $typeTemplate; + /** @var \Spatie\SchemaOrg\Generator\Writer\Template */ + protected $builderClassTemplate; + public function __construct(string $root) { $adapter = new Local($root); $this->flysystem = new Flysystem($adapter); + $this->contractTemplate = new Template('Contract.php.twig'); $this->typeTemplate = new Template('Type.php.twig'); $this->builderClassTemplate = new Template('Schema.php.twig'); } @@ -48,6 +55,11 @@ public function cloneStaticFiles() public function createType(Type $type) { + $this->flysystem->put( + "src/Contracts/{$type->name}Contract.php", + $this->contractTemplate->render(['type' => $type]) + ); + $this->flysystem->put( "src/{$type->name}.php", $this->typeTemplate->render(['type' => $type]) From 6b4085c423c270c51a82f20fa710544017c1ee81 Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 13:31:02 +0200 Subject: [PATCH 04/13] use contracts in types --- generator/templates/twig/Type.php.twig | 30 ++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/generator/templates/twig/Type.php.twig b/generator/templates/twig/Type.php.twig index 167df0db9..ca714fdd7 100644 --- a/generator/templates/twig/Type.php.twig +++ b/generator/templates/twig/Type.php.twig @@ -2,21 +2,23 @@ namespace Spatie\SchemaOrg; +{% for parent in type.parents %} +use \Spatie\SchemaOrg\Contracts\{{ parent }}Contract; +{% endfor %} +{% for grandParent in type.grandParents %} +use \Spatie\SchemaOrg\Contracts\{{ grandParent }}Contract; +{% endfor %} + /** * {{ type.description | doc(0) }} * * @see {{ type.resource }} -{% if type.parents %} * -{% for parent in type.parents %} - * @mixin \Spatie\SchemaOrg\{{ parent }} -{% endfor %} {% for property in type.properties if property.pending %} * @method static {{ property.name }}(${{ property.name }}) The value should be instance of pending types {{ property.ranges | join('|') }} {% endfor %} -{% endif %} */ -class {{ type.name }} extends BaseType +class {{ type.name }} extends BaseType{% if type.parents or type.grandParents %} implements {% endif %}{{ type.parents|map(parent => "#{parent}Contract")|join(', ') }}{% if type.grandParents %}, {% endif %}{{ type.grandParents|map(grandParent => "#{grandParent}Contract")|join(', ') }} { {% for constant in type.constants %} /** @@ -42,5 +44,21 @@ class {{ type.name }} extends BaseType return $this->setProperty('{{ property.name }}', ${{ property.name }}); } +{% endfor %} +{% for parentProperty in type.parentProperties if not parentProperty.pending %} + /** + * {{ parentProperty.description | doc(1) }} + * + * @param {{ parentProperty.ranges | join('|') }} ${{ parentProperty.name }} + * + * @return static + * + * @see {{ parentProperty.resource }} + */ + public function {{ parentProperty.name }}(${{ parentProperty.name }}) + { + return $this->setProperty('{{ parentProperty.name }}', ${{ parentProperty.name }}); + } + {% endfor %} } From 0f358910e21f623aa8e9d7a1dcce379123c20402 Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 13:31:26 +0200 Subject: [PATCH 05/13] generated files --- src/AMRadioChannel.php | 282 ++- src/APIReference.php | 1667 +++++++++++++- src/AboutPage.php | 1682 +++++++++++++- src/AcceptAction.php | 373 +++- src/Accommodation.php | 672 +++++- src/AccountingService.php | 1345 +++++++++++- src/AchieveAction.php | 371 +++- src/Action.php | 191 +- src/ActionAccessSpecification.php | 192 +- src/ActionStatusType.php | 193 +- src/ActivateAction.php | 372 +++- src/AddAction.php | 400 +++- src/AdministrativeArea.php | 672 +++++- src/AdultEntertainment.php | 1330 ++++++++++- src/AggregateOffer.php | 838 ++++++- src/AggregateRating.php | 275 ++- src/AgreeAction.php | 373 +++- src/Airline.php | 928 +++++++- src/Airport.php | 702 +++++- src/AlignmentObject.php | 192 +- src/AllocateAction.php | 372 +++- src/AmusementPark.php | 1330 ++++++++++- src/AnimalShelter.php | 1329 ++++++++++- src/Answer.php | 1556 ++++++++++++- src/Apartment.php | 735 ++++++- src/ApartmentComplex.php | 673 +++++- src/AppendAction.php | 417 +++- src/ApplyAction.php | 372 +++- src/Aquarium.php | 702 +++++- src/ArriveAction.php | 402 +++- src/ArtGallery.php | 1330 ++++++++++- src/Article.php | 1511 ++++++++++++- src/AskAction.php | 433 +++- src/AssessAction.php | 371 +++- src/AssignAction.php | 373 +++- src/Attorney.php | 1330 ++++++++++- src/Audience.php | 192 +- src/AudioObject.php | 1763 ++++++++++++++- src/AuthorizeAction.php | 373 +++- src/AutoBodyShop.php | 1330 ++++++++++- src/AutoDealer.php | 1330 ++++++++++- src/AutoPartsStore.php | 1332 ++++++++++- src/AutoRental.php | 1330 ++++++++++- src/AutoRepair.php | 1330 ++++++++++- src/AutoWash.php | 1330 ++++++++++- src/AutomatedTeller.php | 1345 +++++++++++- src/AutomotiveBusiness.php | 1329 ++++++++++- src/Bakery.php | 1407 +++++++++++- src/BankAccount.php | 579 ++++- src/BankOrCreditUnion.php | 1345 +++++++++++- src/BarOrPub.php | 1407 +++++++++++- src/Barcode.php | 1823 +++++++++++++++- src/Beach.php | 702 +++++- src/BeautySalon.php | 1330 ++++++++++- src/BedAndBreakfast.php | 1437 +++++++++++- src/BedDetails.php | 192 +- src/BedType.php | 321 ++- src/BefriendAction.php | 372 +++- src/BikeStore.php | 1330 ++++++++++- src/Blog.php | 1511 ++++++++++++- src/BlogPosting.php | 1653 +++++++++++++- src/BoardingPolicyType.php | 193 +- src/BodyOfWater.php | 673 +++++- src/Book.php | 1511 ++++++++++++- src/BookFormatType.php | 193 +- src/BookSeries.php | 1576 +++++++++++++- src/BookStore.php | 1330 ++++++++++- src/BookmarkAction.php | 372 +++- src/BorrowAction.php | 402 +++- src/BowlingAlley.php | 1330 ++++++++++- src/Brand.php | 192 +- src/BreadcrumbList.php | 248 ++- src/Brewery.php | 1407 +++++++++++- src/Bridge.php | 702 +++++- src/BroadcastChannel.php | 192 +- src/BroadcastEvent.php | 746 ++++++- src/BroadcastFrequencySpecification.php | 192 +- src/BroadcastService.php | 531 ++++- src/BuddhistTemple.php | 703 +++++- src/BusReservation.php | 399 +++- src/BusStation.php | 702 +++++- src/BusStop.php | 702 +++++- src/BusTrip.php | 253 ++- src/BusinessAudience.php | 222 +- src/BusinessEntityType.php | 193 +- src/BusinessEvent.php | 717 +++++- src/BusinessFunction.php | 193 +- src/BuyAction.php | 447 +++- src/CableOrSatelliteService.php | 531 ++++- src/CafeOrCoffeeShop.php | 1407 +++++++++++- src/Campground.php | 1439 +++++++++++- src/CampingPitch.php | 735 ++++++- src/Canal.php | 674 +++++- src/CancelAction.php | 387 +++- src/Car.php | 1108 +++++++++- src/Casino.php | 1330 ++++++++++- src/CatholicChurch.php | 704 +++++- src/Cemetery.php | 702 +++++- src/CheckAction.php | 372 +++- src/CheckInAction.php | 433 +++- src/CheckOutAction.php | 433 +++- src/CheckoutPage.php | 1682 +++++++++++++- src/ChildCare.php | 1329 ++++++++++- src/ChildrensEvent.php | 717 +++++- src/ChooseAction.php | 372 +++- src/Church.php | 703 +++++- src/City.php | 673 +++++- src/CityHall.php | 703 +++++- src/CivicStructure.php | 672 +++++- src/ClaimReview.php | 1572 ++++++++++++- src/Clip.php | 1511 ++++++++++++- src/ClothingStore.php | 1330 ++++++++++- src/Code.php | 1511 ++++++++++++- src/CollectionPage.php | 1682 +++++++++++++- src/CollegeOrUniversity.php | 943 +++++++- src/ComedyClub.php | 1330 ++++++++++- src/ComedyEvent.php | 717 +++++- src/Comment.php | 1511 ++++++++++++- src/CommentAction.php | 433 +++- src/CommunicateAction.php | 372 +++- src/CompoundPriceSpecification.php | 359 ++- src/ComputerLanguage.php | 192 +- src/ComputerStore.php | 1330 ++++++++++- src/ConfirmAction.php | 449 +++- src/ConsumeAction.php | 371 +++- src/ContactPage.php | 1682 +++++++++++++- src/ContactPoint.php | 193 +- src/ContactPointOption.php | 193 +- src/Continent.php | 673 +++++- src/Contracts/AMRadioChannelContract.php | 43 + src/Contracts/APIReferenceContract.php | 229 ++ src/Contracts/AboutPageContract.php | 221 ++ src/Contracts/AcceptActionContract.php | 53 + src/Contracts/AccommodationContract.php | 105 + src/Contracts/AccountingServiceContract.php | 183 ++ src/Contracts/AchieveActionContract.php | 53 + .../ActionAccessSpecificationContract.php | 43 + src/Contracts/ActionContract.php | 53 + src/Contracts/ActionStatusTypeContract.php | 31 + src/Contracts/ActivateActionContract.php | 53 + src/Contracts/AddActionContract.php | 57 + src/Contracts/AdministrativeAreaContract.php | 95 + src/Contracts/AdultEntertainmentContract.php | 181 ++ src/Contracts/AggregateOfferContract.php | 119 + src/Contracts/AggregateRatingContract.php | 47 + src/Contracts/AgreeActionContract.php | 53 + src/Contracts/AirlineContract.php | 135 ++ src/Contracts/AirportContract.php | 101 + src/Contracts/AlignmentObjectContract.php | 41 + src/Contracts/AllocateActionContract.php | 53 + src/Contracts/AmusementParkContract.php | 181 ++ src/Contracts/AnimalShelterContract.php | 181 ++ src/Contracts/AnswerContract.php | 207 ++ src/Contracts/ApartmentComplexContract.php | 95 + src/Contracts/ApartmentContract.php | 107 + src/Contracts/AppendActionContract.php | 59 + src/Contracts/ApplyActionContract.php | 53 + src/Contracts/AquariumContract.php | 97 + src/Contracts/ArriveActionContract.php | 57 + src/Contracts/ArtGalleryContract.php | 181 ++ src/Contracts/ArticleContract.php | 215 ++ src/Contracts/AskActionContract.php | 63 + src/Contracts/AssessActionContract.php | 53 + src/Contracts/AssignActionContract.php | 53 + src/Contracts/AttorneyContract.php | 181 ++ src/Contracts/AudienceContract.php | 35 + src/Contracts/AudioObjectContract.php | 237 ++ src/Contracts/AuthorizeActionContract.php | 55 + src/Contracts/AutoBodyShopContract.php | 181 ++ src/Contracts/AutoDealerContract.php | 181 ++ src/Contracts/AutoPartsStoreContract.php | 181 ++ src/Contracts/AutoRentalContract.php | 181 ++ src/Contracts/AutoRepairContract.php | 181 ++ src/Contracts/AutoWashContract.php | 181 ++ src/Contracts/AutomatedTellerContract.php | 183 ++ src/Contracts/AutomotiveBusinessContract.php | 181 ++ src/Contracts/BakeryContract.php | 191 ++ src/Contracts/BankAccountContract.php | 83 + src/Contracts/BankOrCreditUnionContract.php | 183 ++ src/Contracts/BarOrPubContract.php | 191 ++ src/Contracts/BarcodeContract.php | 241 ++ src/Contracts/BeachContract.php | 97 + src/Contracts/BeautySalonContract.php | 181 ++ src/Contracts/BedAndBreakfastContract.php | 195 ++ src/Contracts/BedDetailsContract.php | 35 + src/Contracts/BedTypeContract.php | 47 + src/Contracts/BefriendActionContract.php | 53 + src/Contracts/BikeStoreContract.php | 181 ++ src/Contracts/BlogContract.php | 207 ++ src/Contracts/BlogPostingContract.php | 217 ++ src/Contracts/BoardingPolicyTypeContract.php | 31 + src/Contracts/BodyOfWaterContract.php | 95 + src/Contracts/BookContract.php | 211 ++ src/Contracts/BookFormatTypeContract.php | 31 + src/Contracts/BookSeriesContract.php | 209 ++ src/Contracts/BookStoreContract.php | 181 ++ src/Contracts/BookmarkActionContract.php | 53 + src/Contracts/BorrowActionContract.php | 59 + src/Contracts/BowlingAlleyContract.php | 181 ++ src/Contracts/BrandContract.php | 39 + src/Contracts/BreadcrumbListContract.php | 37 + src/Contracts/BreweryContract.php | 191 ++ src/Contracts/BridgeContract.php | 97 + src/Contracts/BroadcastChannelContract.php | 43 + src/Contracts/BroadcastEventContract.php | 111 + ...roadcastFrequencySpecificationContract.php | 33 + src/Contracts/BroadcastServiceContract.php | 95 + src/Contracts/BuddhistTempleContract.php | 97 + src/Contracts/BusReservationContract.php | 57 + src/Contracts/BusStationContract.php | 97 + src/Contracts/BusStopContract.php | 97 + src/Contracts/BusTripContract.php | 47 + src/Contracts/BusinessAudienceContract.php | 41 + src/Contracts/BusinessEntityTypeContract.php | 31 + src/Contracts/BusinessEventContract.php | 101 + src/Contracts/BusinessFunctionContract.php | 31 + src/Contracts/BuyActionContract.php | 65 + .../CableOrSatelliteServiceContract.php | 77 + src/Contracts/CafeOrCoffeeShopContract.php | 191 ++ src/Contracts/CampgroundContract.php | 195 ++ src/Contracts/CampingPitchContract.php | 103 + src/Contracts/CanalContract.php | 95 + src/Contracts/CancelActionContract.php | 55 + src/Contracts/CarContract.php | 147 ++ src/Contracts/CasinoContract.php | 181 ++ src/Contracts/CatholicChurchContract.php | 97 + src/Contracts/CemeteryContract.php | 97 + src/Contracts/CheckActionContract.php | 53 + src/Contracts/CheckInActionContract.php | 61 + src/Contracts/CheckOutActionContract.php | 61 + src/Contracts/CheckoutPageContract.php | 221 ++ src/Contracts/ChildCareContract.php | 181 ++ src/Contracts/ChildrensEventContract.php | 101 + src/Contracts/ChooseActionContract.php | 57 + src/Contracts/ChurchContract.php | 97 + src/Contracts/CityContract.php | 95 + src/Contracts/CityHallContract.php | 97 + src/Contracts/CivicStructureContract.php | 97 + src/Contracts/ClaimReviewContract.php | 211 ++ src/Contracts/ClipContract.php | 219 ++ src/Contracts/ClothingStoreContract.php | 181 ++ src/Contracts/CodeContract.php | 201 ++ src/Contracts/CollectionPageContract.php | 221 ++ src/Contracts/CollegeOrUniversityContract.php | 133 ++ src/Contracts/ComedyClubContract.php | 181 ++ src/Contracts/ComedyEventContract.php | 101 + src/Contracts/CommentActionContract.php | 63 + src/Contracts/CommentContract.php | 207 ++ src/Contracts/CommunicateActionContract.php | 61 + .../CompoundPriceSpecificationContract.php | 51 + src/Contracts/ComputerLanguageContract.php | 31 + src/Contracts/ComputerStoreContract.php | 181 ++ src/Contracts/ConfirmActionContract.php | 63 + src/Contracts/ConsumeActionContract.php | 57 + src/Contracts/ContactPageContract.php | 221 ++ src/Contracts/ContactPointContract.php | 51 + src/Contracts/ContactPointOptionContract.php | 31 + src/Contracts/ContinentContract.php | 95 + src/Contracts/ControlActionContract.php | 53 + src/Contracts/ConvenienceStoreContract.php | 181 ++ src/Contracts/ConversationContract.php | 201 ++ src/Contracts/CookActionContract.php | 59 + src/Contracts/CorporationContract.php | 133 ++ src/Contracts/CountryContract.php | 95 + src/Contracts/CourseContract.php | 207 ++ src/Contracts/CourseInstanceContract.php | 105 + src/Contracts/CourthouseContract.php | 97 + src/Contracts/CreateActionContract.php | 53 + src/Contracts/CreativeWorkContract.php | 201 ++ src/Contracts/CreativeWorkSeasonContract.php | 223 ++ src/Contracts/CreativeWorkSeriesContract.php | 209 ++ src/Contracts/CreditCardContract.php | 89 + src/Contracts/CrematoriumContract.php | 97 + .../CurrencyConversionServiceContract.php | 83 + src/Contracts/DanceEventContract.php | 101 + src/Contracts/DanceGroupContract.php | 131 ++ src/Contracts/DataCatalogContract.php | 203 ++ src/Contracts/DataDownloadContract.php | 233 ++ src/Contracts/DataFeedContract.php | 215 ++ src/Contracts/DataFeedItemContract.php | 39 + src/Contracts/DatasetContract.php | 213 ++ .../DatedMoneySpecificationContract.php | 35 + src/Contracts/DayOfWeekContract.php | 31 + src/Contracts/DaySpaContract.php | 181 ++ src/Contracts/DeactivateActionContract.php | 53 + .../DefenceEstablishmentContract.php | 97 + src/Contracts/DeleteActionContract.php | 57 + .../DeliveryChargeSpecificationContract.php | 57 + src/Contracts/DeliveryEventContract.php | 109 + src/Contracts/DeliveryMethodContract.php | 31 + src/Contracts/DemandContract.php | 95 + src/Contracts/DentistContract.php | 181 ++ src/Contracts/DepartActionContract.php | 57 + src/Contracts/DepartmentStoreContract.php | 181 ++ src/Contracts/DepositAccountContract.php | 85 + src/Contracts/DigitalDocumentContract.php | 203 ++ .../DigitalDocumentPermissionContract.php | 35 + .../DigitalDocumentPermissionTypeContract.php | 31 + src/Contracts/DisagreeActionContract.php | 53 + src/Contracts/DiscoverActionContract.php | 53 + .../DiscussionForumPostingContract.php | 217 ++ src/Contracts/DislikeActionContract.php | 53 + src/Contracts/DistanceContract.php | 31 + src/Contracts/DistilleryContract.php | 191 ++ src/Contracts/DonateActionContract.php | 61 + src/Contracts/DownloadActionContract.php | 57 + src/Contracts/DrawActionContract.php | 53 + src/Contracts/DrinkActionContract.php | 57 + .../DriveWheelConfigurationValueContract.php | 47 + .../DryCleaningOrLaundryContract.php | 181 ++ src/Contracts/DurationContract.php | 31 + src/Contracts/EatActionContract.php | 57 + src/Contracts/EducationEventContract.php | 101 + src/Contracts/EducationalAudienceContract.php | 37 + .../EducationalOrganizationContract.php | 133 ++ src/Contracts/ElectricianContract.php | 181 ++ src/Contracts/ElectronicsStoreContract.php | 181 ++ src/Contracts/ElementarySchoolContract.php | 133 ++ src/Contracts/EmailMessageContract.php | 219 ++ src/Contracts/EmbassyContract.php | 97 + src/Contracts/EmergencyServiceContract.php | 181 ++ src/Contracts/EmployeeRoleContract.php | 45 + .../EmployerAggregateRatingContract.php | 47 + src/Contracts/EmploymentAgencyContract.php | 181 ++ src/Contracts/EndorseActionContract.php | 55 + src/Contracts/EndorsementRatingContract.php | 41 + src/Contracts/EnergyContract.php | 31 + src/Contracts/EngineSpecificationContract.php | 33 + .../EntertainmentBusinessContract.php | 181 ++ src/Contracts/EntryPointContract.php | 45 + src/Contracts/EnumerationContract.php | 31 + src/Contracts/EpisodeContract.php | 221 ++ src/Contracts/EventContract.php | 101 + src/Contracts/EventReservationContract.php | 57 + src/Contracts/EventStatusTypeContract.php | 31 + src/Contracts/EventVenueContract.php | 97 + src/Contracts/ExerciseActionContract.php | 75 + src/Contracts/ExerciseGymContract.php | 181 ++ src/Contracts/ExhibitionEventContract.php | 101 + src/Contracts/FAQPageContract.php | 221 ++ src/Contracts/FMRadioChannelContract.php | 43 + src/Contracts/FastFoodRestaurantContract.php | 191 ++ src/Contracts/FestivalContract.php | 101 + src/Contracts/FilmActionContract.php | 53 + src/Contracts/FinancialProductContract.php | 83 + src/Contracts/FinancialServiceContract.php | 183 ++ src/Contracts/FindActionContract.php | 53 + src/Contracts/FireStationContract.php | 181 ++ src/Contracts/FlightContract.php | 69 + src/Contracts/FlightReservationContract.php | 63 + src/Contracts/FloristContract.php | 181 ++ src/Contracts/FollowActionContract.php | 55 + src/Contracts/FoodEstablishmentContract.php | 191 ++ .../FoodEstablishmentReservationContract.php | 63 + src/Contracts/FoodEventContract.php | 101 + src/Contracts/FoodServiceContract.php | 77 + src/Contracts/FurnitureStoreContract.php | 181 ++ src/Contracts/GameContract.php | 211 ++ src/Contracts/GamePlayModeContract.php | 31 + src/Contracts/GameServerContract.php | 37 + src/Contracts/GameServerStatusContract.php | 31 + src/Contracts/GardenStoreContract.php | 181 ++ src/Contracts/GasStationContract.php | 181 ++ .../GatedResidenceCommunityContract.php | 95 + src/Contracts/GenderTypeContract.php | 31 + src/Contracts/GeneralContractorContract.php | 181 ++ src/Contracts/GeoCircleContract.php | 51 + src/Contracts/GeoCoordinatesContract.php | 43 + src/Contracts/GeoShapeContract.php | 49 + src/Contracts/GiveActionContract.php | 59 + src/Contracts/GolfCourseContract.php | 181 ++ src/Contracts/GovernmentBuildingContract.php | 97 + src/Contracts/GovernmentOfficeContract.php | 181 ++ .../GovernmentOrganizationContract.php | 131 ++ src/Contracts/GovernmentPermitContract.php | 45 + src/Contracts/GovernmentServiceContract.php | 79 + src/Contracts/GroceryStoreContract.php | 181 ++ src/Contracts/HVACBusinessContract.php | 181 ++ src/Contracts/HairSalonContract.php | 181 ++ src/Contracts/HardwareStoreContract.php | 181 ++ .../HealthAndBeautyBusinessContract.php | 181 ++ src/Contracts/HealthClubContract.php | 181 ++ src/Contracts/HighSchoolContract.php | 133 ++ src/Contracts/HinduTempleContract.php | 97 + src/Contracts/HobbyShopContract.php | 181 ++ .../HomeAndConstructionBusinessContract.php | 181 ++ src/Contracts/HomeGoodsStoreContract.php | 181 ++ src/Contracts/HospitalContract.php | 181 ++ src/Contracts/HostelContract.php | 195 ++ src/Contracts/HotelContract.php | 195 ++ src/Contracts/HotelRoomContract.php | 107 + src/Contracts/HouseContract.php | 105 + src/Contracts/HousePainterContract.php | 181 ++ src/Contracts/HowToContract.php | 219 ++ src/Contracts/HowToDirectionContract.php | 223 ++ src/Contracts/HowToItemContract.php | 41 + src/Contracts/HowToSectionContract.php | 215 ++ src/Contracts/HowToStepContract.php | 213 ++ src/Contracts/HowToSupplyContract.php | 43 + src/Contracts/HowToTipContract.php | 207 ++ src/Contracts/HowToToolContract.php | 41 + src/Contracts/IceCreamShopContract.php | 191 ++ src/Contracts/IgnoreActionContract.php | 53 + src/Contracts/ImageGalleryContract.php | 221 ++ src/Contracts/ImageObjectContract.php | 241 ++ src/Contracts/IndividualProductContract.php | 103 + src/Contracts/InformActionContract.php | 63 + src/Contracts/InsertActionContract.php | 59 + src/Contracts/InstallActionContract.php | 57 + src/Contracts/InsuranceAgencyContract.php | 183 ++ src/Contracts/IntangibleContract.php | 31 + src/Contracts/InteractActionContract.php | 53 + src/Contracts/InteractionCounterContract.php | 33 + src/Contracts/InternetCafeContract.php | 181 ++ src/Contracts/InvestmentOrDepositContract.php | 85 + src/Contracts/InviteActionContract.php | 63 + src/Contracts/InvoiceContract.php | 63 + src/Contracts/ItemAvailabilityContract.php | 31 + src/Contracts/ItemListContract.php | 37 + src/Contracts/ItemListOrderTypeContract.php | 31 + src/Contracts/ItemPageContract.php | 221 ++ src/Contracts/JewelryStoreContract.php | 181 ++ src/Contracts/JobPostingContract.php | 77 + src/Contracts/JoinActionContract.php | 55 + src/Contracts/LakeBodyOfWaterContract.php | 95 + src/Contracts/LandformContract.php | 95 + ...LandmarksOrHistoricalBuildingsContract.php | 95 + src/Contracts/LanguageContract.php | 31 + src/Contracts/LeaveActionContract.php | 55 + src/Contracts/LegalServiceContract.php | 181 ++ src/Contracts/LegislativeBuildingContract.php | 97 + src/Contracts/LendActionContract.php | 59 + src/Contracts/LibraryContract.php | 181 ++ src/Contracts/LikeActionContract.php | 53 + src/Contracts/LiquorStoreContract.php | 181 ++ src/Contracts/ListItemContract.php | 39 + src/Contracts/ListenActionContract.php | 57 + src/Contracts/LiteraryEventContract.php | 101 + src/Contracts/LiveBlogPostingContract.php | 223 ++ src/Contracts/LoanOrCreditContract.php | 89 + src/Contracts/LocalBusinessContract.php | 181 ++ .../LocationFeatureSpecificationContract.php | 51 + src/Contracts/LockerDeliveryContract.php | 31 + src/Contracts/LocksmithContract.php | 181 ++ src/Contracts/LodgingBusinessContract.php | 197 ++ src/Contracts/LodgingReservationContract.php | 69 + src/Contracts/LoseActionContract.php | 55 + src/Contracts/MapCategoryTypeContract.php | 31 + src/Contracts/MapContract.php | 203 ++ src/Contracts/MarryActionContract.php | 53 + src/Contracts/MassContract.php | 31 + src/Contracts/MediaObjectContract.php | 235 ++ src/Contracts/MediaSubscriptionContract.php | 35 + src/Contracts/MedicalOrganizationContract.php | 131 ++ src/Contracts/MeetingRoomContract.php | 103 + src/Contracts/MensClothingStoreContract.php | 181 ++ src/Contracts/MenuContract.php | 205 ++ src/Contracts/MenuItemContract.php | 209 ++ src/Contracts/MenuSectionContract.php | 205 ++ src/Contracts/MessageContract.php | 219 ++ src/Contracts/MiddleSchoolContract.php | 133 ++ src/Contracts/MobileApplicationContract.php | 251 +++ src/Contracts/MobilePhoneStoreContract.php | 181 ++ src/Contracts/MonetaryAmountContract.php | 39 + .../MonetaryAmountDistributionContract.php | 43 + src/Contracts/MosqueContract.php | 97 + src/Contracts/MotelContract.php | 195 ++ src/Contracts/MotorcycleDealerContract.php | 181 ++ src/Contracts/MotorcycleRepairContract.php | 181 ++ src/Contracts/MountainContract.php | 95 + src/Contracts/MoveActionContract.php | 57 + src/Contracts/MovieClipContract.php | 219 ++ src/Contracts/MovieContract.php | 221 ++ src/Contracts/MovieRentalStoreContract.php | 181 ++ src/Contracts/MovieSeriesContract.php | 221 ++ src/Contracts/MovieTheaterContract.php | 183 ++ src/Contracts/MovingCompanyContract.php | 181 ++ src/Contracts/MuseumContract.php | 97 + src/Contracts/MusicAlbumContract.php | 215 ++ .../MusicAlbumProductionTypeContract.php | 31 + .../MusicAlbumReleaseTypeContract.php | 31 + src/Contracts/MusicCompositionContract.php | 221 ++ src/Contracts/MusicEventContract.php | 101 + src/Contracts/MusicGroupContract.php | 143 ++ src/Contracts/MusicPlaylistContract.php | 207 ++ src/Contracts/MusicRecordingContract.php | 213 ++ src/Contracts/MusicReleaseContract.php | 217 ++ .../MusicReleaseFormatTypeContract.php | 31 + src/Contracts/MusicStoreContract.php | 181 ++ src/Contracts/MusicVenueContract.php | 97 + src/Contracts/MusicVideoObjectContract.php | 233 ++ src/Contracts/NGOContract.php | 131 ++ src/Contracts/NailSalonContract.php | 181 ++ src/Contracts/NewsArticleContract.php | 225 ++ src/Contracts/NightClubContract.php | 181 ++ src/Contracts/NotaryContract.php | 181 ++ src/Contracts/NoteDigitalDocumentContract.php | 203 ++ .../NutritionInformationContract.php | 55 + src/Contracts/OccupationContract.php | 47 + src/Contracts/OceanBodyOfWaterContract.php | 95 + src/Contracts/OfferCatalogContract.php | 37 + src/Contracts/OfferContract.php | 111 + src/Contracts/OfferItemConditionContract.php | 31 + .../OfficeEquipmentStoreContract.php | 181 ++ src/Contracts/OnDemandEventContract.php | 105 + .../OpeningHoursSpecificationContract.php | 41 + src/Contracts/OrderActionContract.php | 61 + src/Contracts/OrderContract.php | 75 + src/Contracts/OrderItemContract.php | 41 + src/Contracts/OrderStatusContract.php | 31 + src/Contracts/OrganizationContract.php | 131 ++ src/Contracts/OrganizationRoleContract.php | 41 + src/Contracts/OrganizeActionContract.php | 53 + src/Contracts/OutletStoreContract.php | 181 ++ src/Contracts/OwnershipInfoContract.php | 39 + src/Contracts/PaintActionContract.php | 53 + src/Contracts/PaintingContract.php | 201 ++ src/Contracts/ParcelDeliveryContract.php | 55 + src/Contracts/ParcelServiceContract.php | 31 + src/Contracts/ParentAudienceContract.php | 51 + src/Contracts/ParkContract.php | 97 + src/Contracts/ParkingFacilityContract.php | 97 + src/Contracts/PawnShopContract.php | 181 ++ src/Contracts/PayActionContract.php | 61 + src/Contracts/PaymentCardContract.php | 83 + .../PaymentChargeSpecificationContract.php | 53 + src/Contracts/PaymentMethodContract.php | 31 + src/Contracts/PaymentServiceContract.php | 83 + src/Contracts/PaymentStatusTypeContract.php | 31 + src/Contracts/PeopleAudienceContract.php | 47 + src/Contracts/PerformActionContract.php | 59 + src/Contracts/PerformanceRoleContract.php | 41 + .../PerformingArtsTheaterContract.php | 97 + src/Contracts/PerformingGroupContract.php | 131 ++ src/Contracts/PeriodicalContract.php | 209 ++ src/Contracts/PermitContract.php | 45 + src/Contracts/PersonContract.php | 145 ++ src/Contracts/PetStoreContract.php | 181 ++ src/Contracts/PharmacyContract.php | 131 ++ src/Contracts/PhotographActionContract.php | 53 + src/Contracts/PhotographContract.php | 201 ++ src/Contracts/PhysicianContract.php | 131 ++ src/Contracts/PlaceContract.php | 95 + src/Contracts/PlaceOfWorshipContract.php | 97 + src/Contracts/PlanActionContract.php | 55 + src/Contracts/PlayActionContract.php | 57 + src/Contracts/PlaygroundContract.php | 97 + src/Contracts/PlumberContract.php | 181 ++ src/Contracts/PoliceStationContract.php | 181 ++ src/Contracts/PondContract.php | 95 + src/Contracts/PostOfficeContract.php | 181 ++ src/Contracts/PostalAddressContract.php | 63 + src/Contracts/PreOrderActionContract.php | 59 + src/Contracts/PrependActionContract.php | 59 + src/Contracts/PreschoolContract.php | 133 ++ .../PresentationDigitalDocumentContract.php | 203 ++ src/Contracts/PriceSpecificationContract.php | 49 + src/Contracts/ProductContract.php | 101 + src/Contracts/ProductModelContract.php | 107 + src/Contracts/ProfessionalServiceContract.php | 181 ++ src/Contracts/ProfilePageContract.php | 221 ++ src/Contracts/ProgramMembershipContract.php | 41 + src/Contracts/PropertyValueContract.php | 45 + .../PropertyValueSpecificationContract.php | 53 + src/Contracts/PublicSwimmingPoolContract.php | 181 ++ src/Contracts/PublicationEventContract.php | 107 + src/Contracts/PublicationIssueContract.php | 209 ++ src/Contracts/PublicationVolumeContract.php | 209 ++ src/Contracts/QAPageContract.php | 221 ++ src/Contracts/QualitativeValueContract.php | 47 + src/Contracts/QuantitativeValueContract.php | 45 + .../QuantitativeValueDistributionContract.php | 41 + src/Contracts/QuantityContract.php | 31 + src/Contracts/QuestionContract.php | 211 ++ src/Contracts/QuoteActionContract.php | 59 + src/Contracts/RVParkContract.php | 97 + src/Contracts/RadioChannelContract.php | 43 + src/Contracts/RadioClipContract.php | 219 ++ src/Contracts/RadioEpisodeContract.php | 221 ++ src/Contracts/RadioSeasonContract.php | 223 ++ src/Contracts/RadioSeriesContract.php | 237 ++ src/Contracts/RadioStationContract.php | 181 ++ src/Contracts/RatingContract.php | 41 + src/Contracts/ReactActionContract.php | 53 + src/Contracts/ReadActionContract.php | 57 + src/Contracts/RealEstateAgentContract.php | 181 ++ src/Contracts/ReceiveActionContract.php | 61 + src/Contracts/RecipeContract.php | 239 ++ src/Contracts/RecyclingCenterContract.php | 181 ++ src/Contracts/RegisterActionContract.php | 53 + src/Contracts/RejectActionContract.php | 53 + src/Contracts/RentActionContract.php | 63 + .../RentalCarReservationContract.php | 65 + src/Contracts/ReplaceActionContract.php | 61 + src/Contracts/ReplyActionContract.php | 63 + src/Contracts/ReportContract.php | 217 ++ src/Contracts/ReservationContract.php | 57 + src/Contracts/ReservationPackageContract.php | 61 + .../ReservationStatusTypeContract.php | 31 + src/Contracts/ReserveActionContract.php | 55 + src/Contracts/ReservoirContract.php | 95 + src/Contracts/ResidenceContract.php | 95 + src/Contracts/ResortContract.php | 195 ++ src/Contracts/RestaurantContract.php | 191 ++ src/Contracts/RestrictedDietContract.php | 31 + src/Contracts/ResumeActionContract.php | 53 + src/Contracts/ReturnActionContract.php | 59 + src/Contracts/ReviewActionContract.php | 55 + src/Contracts/ReviewContract.php | 209 ++ src/Contracts/RiverBodyOfWaterContract.php | 95 + src/Contracts/RoleContract.php | 39 + src/Contracts/RoofingContractorContract.php | 181 ++ src/Contracts/RoomContract.php | 103 + src/Contracts/RsvpActionContract.php | 69 + src/Contracts/RsvpResponseTypeContract.php | 31 + src/Contracts/SaleEventContract.php | 101 + src/Contracts/ScheduleActionContract.php | 55 + src/Contracts/ScholarlyArticleContract.php | 215 ++ src/Contracts/SchoolContract.php | 133 ++ src/Contracts/ScreeningEventContract.php | 107 + src/Contracts/SculptureContract.php | 201 ++ src/Contracts/SeaBodyOfWaterContract.php | 95 + src/Contracts/SearchActionContract.php | 55 + src/Contracts/SearchResultsPageContract.php | 221 ++ src/Contracts/SeasonContract.php | 201 ++ src/Contracts/SeatContract.php | 39 + src/Contracts/SelfStorageContract.php | 181 ++ src/Contracts/SellActionContract.php | 63 + src/Contracts/SendActionContract.php | 61 + src/Contracts/SeriesContract.php | 33 + src/Contracts/ServiceChannelContract.php | 47 + src/Contracts/ServiceContract.php | 77 + src/Contracts/ShareActionContract.php | 61 + src/Contracts/ShoeStoreContract.php | 181 ++ src/Contracts/ShoppingCenterContract.php | 181 ++ .../SingleFamilyResidenceContract.php | 107 + .../SiteNavigationElementContract.php | 201 ++ src/Contracts/SkiResortContract.php | 181 ++ src/Contracts/SocialEventContract.php | 101 + src/Contracts/SocialMediaPostingContract.php | 217 ++ src/Contracts/SoftwareApplicationContract.php | 249 +++ src/Contracts/SoftwareSourceCodeContract.php | 215 ++ src/Contracts/SomeProductsContract.php | 103 + .../SpeakableSpecificationContract.php | 31 + src/Contracts/SpecialtyContract.php | 31 + src/Contracts/SportingGoodsStoreContract.php | 181 ++ .../SportsActivityLocationContract.php | 181 ++ src/Contracts/SportsClubContract.php | 181 ++ src/Contracts/SportsEventContract.php | 107 + src/Contracts/SportsOrganizationContract.php | 133 ++ src/Contracts/SportsTeamContract.php | 137 ++ .../SpreadsheetDigitalDocumentContract.php | 203 ++ src/Contracts/StadiumOrArenaContract.php | 181 ++ src/Contracts/StateContract.php | 95 + .../SteeringPositionValueContract.php | 47 + src/Contracts/StoreContract.php | 181 ++ src/Contracts/StructuredValueContract.php | 31 + src/Contracts/SubscribeActionContract.php | 53 + src/Contracts/SubwayStationContract.php | 97 + src/Contracts/SuiteContract.php | 109 + src/Contracts/SuspendActionContract.php | 53 + src/Contracts/SynagogueContract.php | 97 + src/Contracts/TVClipContract.php | 221 ++ src/Contracts/TVEpisodeContract.php | 227 ++ src/Contracts/TVSeasonContract.php | 227 ++ src/Contracts/TVSeriesContract.php | 239 ++ src/Contracts/TableContract.php | 201 ++ src/Contracts/TakeActionContract.php | 57 + src/Contracts/TattooParlorContract.php | 181 ++ src/Contracts/TaxiContract.php | 77 + src/Contracts/TaxiReservationContract.php | 63 + src/Contracts/TaxiServiceContract.php | 77 + src/Contracts/TaxiStandContract.php | 97 + src/Contracts/TechArticleContract.php | 219 ++ src/Contracts/TelevisionChannelContract.php | 43 + src/Contracts/TelevisionStationContract.php | 181 ++ src/Contracts/TennisComplexContract.php | 181 ++ src/Contracts/TextDigitalDocumentContract.php | 203 ++ src/Contracts/TheaterEventContract.php | 101 + src/Contracts/TheaterGroupContract.php | 131 ++ src/Contracts/ThingContract.php | 31 + src/Contracts/TicketContract.php | 47 + src/Contracts/TieActionContract.php | 53 + src/Contracts/TipActionContract.php | 61 + src/Contracts/TireShopContract.php | 181 ++ src/Contracts/TouristAttractionContract.php | 99 + .../TouristInformationCenterContract.php | 181 ++ src/Contracts/ToyStoreContract.php | 181 ++ src/Contracts/TrackActionContract.php | 55 + src/Contracts/TradeActionContract.php | 59 + src/Contracts/TrainReservationContract.php | 57 + src/Contracts/TrainStationContract.php | 97 + src/Contracts/TrainTripContract.php | 51 + src/Contracts/TransferActionContract.php | 57 + src/Contracts/TravelActionContract.php | 59 + src/Contracts/TravelAgencyContract.php | 181 ++ src/Contracts/TripContract.php | 39 + src/Contracts/TypeAndQuantityNodeContract.php | 41 + src/Contracts/UnRegisterActionContract.php | 53 + .../UnitPriceSpecificationContract.php | 59 + src/Contracts/UpdateActionContract.php | 57 + src/Contracts/UseActionContract.php | 57 + src/Contracts/UserBlocksContract.php | 101 + src/Contracts/UserCheckinsContract.php | 101 + src/Contracts/UserCommentsContract.php | 111 + src/Contracts/UserDownloadsContract.php | 101 + src/Contracts/UserInteractionContract.php | 101 + src/Contracts/UserLikesContract.php | 101 + src/Contracts/UserPageVisitsContract.php | 101 + src/Contracts/UserPlaysContract.php | 101 + src/Contracts/UserPlusOnesContract.php | 101 + src/Contracts/UserTweetsContract.php | 101 + src/Contracts/VehicleContract.php | 151 ++ src/Contracts/VideoGalleryContract.php | 221 ++ src/Contracts/VideoGameClipContract.php | 219 ++ src/Contracts/VideoGameContract.php | 281 +++ src/Contracts/VideoGameSeriesContract.php | 253 +++ src/Contracts/VideoObjectContract.php | 253 +++ src/Contracts/ViewActionContract.php | 57 + src/Contracts/VisualArtsEventContract.php | 101 + src/Contracts/VisualArtworkContract.php | 211 ++ src/Contracts/VolcanoContract.php | 95 + src/Contracts/VoteActionContract.php | 59 + src/Contracts/WPAdBlockContract.php | 201 ++ src/Contracts/WPFooterContract.php | 201 ++ src/Contracts/WPHeaderContract.php | 201 ++ src/Contracts/WPSideBarContract.php | 201 ++ src/Contracts/WantActionContract.php | 53 + src/Contracts/WarrantyPromiseContract.php | 35 + src/Contracts/WarrantyScopeContract.php | 31 + src/Contracts/WatchActionContract.php | 57 + src/Contracts/WaterfallContract.php | 95 + src/Contracts/WearActionContract.php | 57 + src/Contracts/WebApplicationContract.php | 251 +++ src/Contracts/WebPageContract.php | 221 ++ src/Contracts/WebPageElementContract.php | 201 ++ src/Contracts/WebSiteContract.php | 203 ++ src/Contracts/WholesaleStoreContract.php | 181 ++ src/Contracts/WinActionContract.php | 55 + src/Contracts/WineryContract.php | 191 ++ src/Contracts/WorkersUnionContract.php | 131 ++ src/Contracts/WriteActionContract.php | 57 + src/Contracts/ZooContract.php | 97 + src/ControlAction.php | 371 +++- src/ConvenienceStore.php | 1330 ++++++++++- src/Conversation.php | 1511 ++++++++++++- src/CookAction.php | 372 +++- src/Corporation.php | 928 +++++++- src/Country.php | 673 +++++- src/Course.php | 1511 ++++++++++++- src/CourseInstance.php | 717 +++++- src/Courthouse.php | 703 +++++- src/CreateAction.php | 371 +++- src/CreativeWork.php | 193 +- src/CreativeWorkSeason.php | 1511 ++++++++++++- src/CreativeWorkSeries.php | 1530 ++++++++++++- src/CreditCard.php | 625 +++++- src/Crematorium.php | 702 +++++- src/CurrencyConversionService.php | 579 ++++- src/DanceEvent.php | 717 +++++- src/DanceGroup.php | 929 +++++++- src/DataCatalog.php | 1511 ++++++++++++- src/DataDownload.php | 1763 ++++++++++++++- src/DataFeed.php | 1601 +++++++++++++- src/DataFeedItem.php | 192 +- src/Dataset.php | 1511 ++++++++++++- src/DatedMoneySpecification.php | 193 +- src/DayOfWeek.php | 193 +- src/DaySpa.php | 1330 ++++++++++- src/DeactivateAction.php | 372 +++- src/DefenceEstablishment.php | 703 +++++- src/DeleteAction.php | 400 +++- src/DeliveryChargeSpecification.php | 359 ++- src/DeliveryEvent.php | 717 +++++- src/DeliveryMethod.php | 193 +- src/Demand.php | 192 +- src/Dentist.php | 1331 ++++++++++- src/DepartAction.php | 402 +++- src/DepartmentStore.php | 1330 ++++++++++- src/DepositAccount.php | 596 ++++- src/DigitalDocument.php | 1511 ++++++++++++- src/DigitalDocumentPermission.php | 192 +- src/DigitalDocumentPermissionType.php | 193 +- src/DisagreeAction.php | 373 +++- src/DiscoverAction.php | 372 +++- src/DiscussionForumPosting.php | 1653 +++++++++++++- src/DislikeAction.php | 373 +++- src/Distance.php | 193 +- src/Distillery.php | 1407 +++++++++++- src/DonateAction.php | 447 +++- src/DownloadAction.php | 402 +++- src/DrawAction.php | 372 +++- src/DrinkAction.php | 404 +++- src/DriveWheelConfigurationValue.php | 321 ++- src/DryCleaningOrLaundry.php | 1329 ++++++++++- src/Duration.php | 193 +- src/EatAction.php | 404 +++- src/EducationEvent.php | 717 +++++- src/EducationalAudience.php | 222 +- src/EducationalOrganization.php | 928 +++++++- src/Electrician.php | 1330 ++++++++++- src/ElectronicsStore.php | 1330 ++++++++++- src/ElementarySchool.php | 943 +++++++- src/EmailMessage.php | 1642 +++++++++++++- src/Embassy.php | 703 +++++- src/EmergencyService.php | 1329 ++++++++++- src/EmployeeRole.php | 272 ++- src/EmployerAggregateRating.php | 318 ++- src/EmploymentAgency.php | 1329 ++++++++++- src/EndorseAction.php | 373 +++- src/EndorsementRating.php | 275 ++- src/Energy.php | 193 +- src/EngineSpecification.php | 193 +- src/EntertainmentBusiness.php | 1329 ++++++++++- src/EntryPoint.php | 192 +- src/Enumeration.php | 192 +- src/Episode.php | 1511 ++++++++++++- src/Event.php | 191 +- src/EventReservation.php | 399 +++- src/EventStatusType.php | 193 +- src/EventVenue.php | 702 +++++- src/ExerciseAction.php | 401 +++- src/ExerciseGym.php | 1330 ++++++++++- src/ExhibitionEvent.php | 717 +++++- src/FAQPage.php | 1682 +++++++++++++- src/FMRadioChannel.php | 282 ++- src/FastFoodRestaurant.php | 1407 +++++++++++- src/Festival.php | 717 +++++- src/FilmAction.php | 372 +++- src/FinancialProduct.php | 531 ++++- src/FinancialService.php | 1329 ++++++++++- src/FindAction.php | 371 +++- src/FireStation.php | 1332 ++++++++++- src/Flight.php | 253 ++- src/FlightReservation.php | 399 +++- src/Florist.php | 1330 ++++++++++- src/FollowAction.php | 372 +++- src/FoodEstablishment.php | 1329 ++++++++++- src/FoodEstablishmentReservation.php | 399 +++- src/FoodEvent.php | 717 +++++- src/FoodService.php | 531 ++++- src/FurnitureStore.php | 1330 ++++++++++- src/Game.php | 1511 ++++++++++++- src/GamePlayMode.php | 193 +- src/GameServer.php | 192 +- src/GameServerStatus.php | 193 +- src/GardenStore.php | 1330 ++++++++++- src/GasStation.php | 1330 ++++++++++- src/GatedResidenceCommunity.php | 673 +++++- src/GenderType.php | 193 +- src/GeneralContractor.php | 1330 ++++++++++- src/GeoCircle.php | 332 ++- src/GeoCoordinates.php | 193 +- src/GeoShape.php | 193 +- src/GiveAction.php | 402 +++- src/GolfCourse.php | 1330 ++++++++++- src/GovernmentBuilding.php | 702 +++++- src/GovernmentOffice.php | 1329 ++++++++++- src/GovernmentOrganization.php | 928 +++++++- src/GovernmentPermit.php | 291 ++- src/GovernmentService.php | 531 ++++- src/GroceryStore.php | 1330 ++++++++++- src/HVACBusiness.php | 1330 ++++++++++- src/HairSalon.php | 1330 ++++++++++- src/HardwareStore.php | 1330 ++++++++++- src/HealthAndBeautyBusiness.php | 1329 ++++++++++- src/HealthClub.php | 1332 ++++++++++- src/HighSchool.php | 943 +++++++- src/HinduTemple.php | 703 +++++- src/HobbyShop.php | 1330 ++++++++++- src/HomeAndConstructionBusiness.php | 1329 ++++++++++- src/HomeGoodsStore.php | 1330 ++++++++++- src/Hospital.php | 1332 ++++++++++- src/Hostel.php | 1437 +++++++++++- src/Hotel.php | 1437 +++++++++++- src/HotelRoom.php | 736 ++++++- src/House.php | 735 ++++++- src/HousePainter.php | 1330 ++++++++++- src/HowTo.php | 1511 ++++++++++++- src/HowToDirection.php | 1556 ++++++++++++- src/HowToItem.php | 250 ++- src/HowToSection.php | 1613 +++++++++++++- src/HowToStep.php | 1613 +++++++++++++- src/HowToSupply.php | 265 ++- src/HowToTip.php | 1556 ++++++++++++- src/HowToTool.php | 265 ++- src/IceCreamShop.php | 1407 +++++++++++- src/IgnoreAction.php | 372 +++- src/ImageGallery.php | 1683 +++++++++++++- src/ImageObject.php | 1763 ++++++++++++++- src/IndividualProduct.php | 726 +++++- src/InformAction.php | 433 +++- src/InsertAction.php | 401 +++- src/InstallAction.php | 404 +++- src/InsuranceAgency.php | 1345 +++++++++++- src/Intangible.php | 191 +- src/InteractAction.php | 371 +++- src/InteractionCounter.php | 193 +- src/InternetCafe.php | 1329 ++++++++++- src/InvestmentOrDeposit.php | 579 ++++- src/InviteAction.php | 433 +++- src/Invoice.php | 192 +- src/ItemAvailability.php | 193 +- src/ItemList.php | 192 +- src/ItemListOrderType.php | 193 +- src/ItemPage.php | 1682 +++++++++++++- src/JewelryStore.php | 1330 ++++++++++- src/JobPosting.php | 192 +- src/JoinAction.php | 372 +++- src/LakeBodyOfWater.php | 674 +++++- src/Landform.php | 672 +++++- src/LandmarksOrHistoricalBuildings.php | 672 +++++- src/Language.php | 192 +- src/LeaveAction.php | 372 +++- src/LegalService.php | 1329 ++++++++++- src/LegislativeBuilding.php | 703 +++++- src/LendAction.php | 402 +++- src/Library.php | 1329 ++++++++++- src/LikeAction.php | 373 +++- src/LiquorStore.php | 1330 ++++++++++- src/ListItem.php | 192 +- src/ListenAction.php | 404 +++- src/LiteraryEvent.php | 717 +++++- src/LiveBlogPosting.php | 1654 +++++++++++++- src/LoanOrCredit.php | 579 ++++- src/LocalBusiness.php | 1235 ++++++++++- src/LocationFeatureSpecification.php | 316 ++- src/LockerDelivery.php | 194 +- src/Locksmith.php | 1330 ++++++++++- src/LodgingBusiness.php | 1329 ++++++++++- src/LodgingReservation.php | 399 +++- src/LoseAction.php | 372 +++- src/Map.php | 1511 ++++++++++++- src/MapCategoryType.php | 193 +- src/MarryAction.php | 372 +++- src/Mass.php | 193 +- src/MediaObject.php | 1511 ++++++++++++- src/MediaSubscription.php | 192 +- src/MedicalOrganization.php | 928 +++++++- src/MeetingRoom.php | 736 ++++++- src/MensClothingStore.php | 1330 ++++++++++- src/Menu.php | 1511 ++++++++++++- src/MenuItem.php | 1511 ++++++++++++- src/MenuSection.php | 1511 ++++++++++++- src/Message.php | 1511 ++++++++++++- src/MiddleSchool.php | 943 +++++++- src/MobileApplication.php | 1863 +++++++++++++++- src/MobilePhoneStore.php | 1330 ++++++++++- src/MonetaryAmount.php | 193 +- src/MonetaryAmountDistribution.php | 264 ++- src/Mosque.php | 703 +++++- src/Motel.php | 1437 +++++++++++- src/MotorcycleDealer.php | 1330 ++++++++++- src/MotorcycleRepair.php | 1330 ++++++++++- src/Mountain.php | 673 +++++- src/MoveAction.php | 371 +++- src/Movie.php | 1511 ++++++++++++- src/MovieClip.php | 1644 +++++++++++++- src/MovieRentalStore.php | 1330 ++++++++++- src/MovieSeries.php | 1576 +++++++++++++- src/MovieTheater.php | 1332 ++++++++++- src/MovingCompany.php | 1330 ++++++++++- src/Museum.php | 702 +++++- src/MusicAlbum.php | 1555 ++++++++++++- src/MusicAlbumProductionType.php | 193 +- src/MusicAlbumReleaseType.php | 193 +- src/MusicComposition.php | 1511 ++++++++++++- src/MusicEvent.php | 717 +++++- src/MusicGroup.php | 929 +++++++- src/MusicPlaylist.php | 1511 ++++++++++++- src/MusicRecording.php | 1511 ++++++++++++- src/MusicRelease.php | 1555 ++++++++++++- src/MusicReleaseFormatType.php | 193 +- src/MusicStore.php | 1330 ++++++++++- src/MusicVenue.php | 702 +++++- src/MusicVideoObject.php | 1763 ++++++++++++++- src/NGO.php | 928 +++++++- src/NailSalon.php | 1330 ++++++++++- src/NewsArticle.php | 1637 +++++++++++++- src/NightClub.php | 1330 ++++++++++- src/Notary.php | 1330 ++++++++++- src/NoteDigitalDocument.php | 1528 ++++++++++++- src/NutritionInformation.php | 193 +- src/Occupation.php | 192 +- src/OceanBodyOfWater.php | 674 +++++- src/Offer.php | 192 +- src/OfferCatalog.php | 248 ++- src/OfferItemCondition.php | 193 +- src/OfficeEquipmentStore.php | 1330 ++++++++++- src/OnDemandEvent.php | 746 ++++++- src/OpeningHoursSpecification.php | 193 +- src/Order.php | 192 +- src/OrderAction.php | 447 +++- src/OrderItem.php | 192 +- src/OrderStatus.php | 193 +- src/Organization.php | 191 +- src/OrganizationRole.php | 256 ++- src/OrganizeAction.php | 371 +++- src/OutletStore.php | 1330 ++++++++++- src/OwnershipInfo.php | 193 +- src/PaintAction.php | 372 +++- src/Painting.php | 1511 ++++++++++++- src/ParcelDelivery.php | 192 +- src/ParcelService.php | 194 +- src/ParentAudience.php | 307 ++- src/Park.php | 702 +++++- src/ParkingFacility.php | 702 +++++- src/PawnShop.php | 1330 ++++++++++- src/PayAction.php | 447 +++- src/PaymentCard.php | 581 ++++- src/PaymentChargeSpecification.php | 359 ++- src/PaymentMethod.php | 193 +- src/PaymentService.php | 579 ++++- src/PaymentStatusType.php | 193 +- src/PeopleAudience.php | 222 +- src/PerformAction.php | 401 +++- src/PerformanceRole.php | 256 ++- src/PerformingArtsTheater.php | 702 +++++- src/PerformingGroup.php | 928 +++++++- src/Periodical.php | 1576 +++++++++++++- src/Permit.php | 192 +- src/Person.php | 191 +- src/PetStore.php | 1330 ++++++++++- src/Pharmacy.php | 929 +++++++- src/Photograph.php | 1511 ++++++++++++- src/PhotographAction.php | 372 +++- src/Physician.php | 929 +++++++- src/Place.php | 221 +- src/PlaceOfWorship.php | 702 +++++- src/PlanAction.php | 372 +++- src/PlayAction.php | 371 +++- src/Playground.php | 702 +++++- src/Plumber.php | 1330 ++++++++++- src/PoliceStation.php | 1332 ++++++++++- src/Pond.php | 674 +++++- src/PostOffice.php | 1330 ++++++++++- src/PostalAddress.php | 342 ++- src/PreOrderAction.php | 447 +++- src/PrependAction.php | 417 +++- src/Preschool.php | 943 +++++++- src/PresentationDigitalDocument.php | 1528 ++++++++++++- src/PriceSpecification.php | 193 +- src/Product.php | 191 +- src/ProductModel.php | 726 +++++- src/ProfessionalService.php | 1329 ++++++++++- src/ProfilePage.php | 1682 +++++++++++++- src/ProgramMembership.php | 192 +- src/PropertyValue.php | 193 +- src/PropertyValueSpecification.php | 192 +- src/PublicSwimmingPool.php | 1330 ++++++++++- src/PublicationEvent.php | 717 +++++- src/PublicationIssue.php | 1511 ++++++++++++- src/PublicationVolume.php | 1511 ++++++++++++- src/QAPage.php | 1682 +++++++++++++- src/QualitativeValue.php | 193 +- src/QuantitativeValue.php | 193 +- src/QuantitativeValueDistribution.php | 193 +- src/Quantity.php | 192 +- src/Question.php | 1511 ++++++++++++- src/QuoteAction.php | 447 +++- src/RVPark.php | 702 +++++- src/RadioChannel.php | 281 ++- src/RadioClip.php | 1644 +++++++++++++- src/RadioEpisode.php | 1659 +++++++++++++- src/RadioSeason.php | 1673 +++++++++++++- src/RadioSeries.php | 1576 +++++++++++++- src/RadioStation.php | 1329 ++++++++++- src/Rating.php | 192 +- src/ReactAction.php | 372 +++- src/ReadAction.php | 404 +++- src/RealEstateAgent.php | 1329 ++++++++++- src/ReceiveAction.php | 402 +++- src/Recipe.php | 1650 +++++++++++++- src/RecyclingCenter.php | 1329 ++++++++++- src/RegisterAction.php | 372 +++- src/RejectAction.php | 373 +++- src/RentAction.php | 447 +++- src/RentalCarReservation.php | 399 +++- src/ReplaceAction.php | 400 +++- src/ReplyAction.php | 433 +++- src/Report.php | 1637 +++++++++++++- src/Reservation.php | 192 +- src/ReservationPackage.php | 399 +++- src/ReservationStatusType.php | 193 +- src/ReserveAction.php | 387 +++- src/Reservoir.php | 674 +++++- src/Residence.php | 672 +++++- src/Resort.php | 1437 +++++++++++- src/Restaurant.php | 1407 +++++++++++- src/RestrictedDiet.php | 193 +- src/ResumeAction.php | 372 +++- src/ReturnAction.php | 402 +++- src/Review.php | 1511 ++++++++++++- src/ReviewAction.php | 372 +++- src/RiverBodyOfWater.php | 674 +++++- src/Role.php | 192 +- src/RoofingContractor.php | 1330 ++++++++++- src/Room.php | 735 ++++++- src/RsvpAction.php | 449 +++- src/RsvpResponseType.php | 193 +- src/SaleEvent.php | 717 +++++- src/ScheduleAction.php | 387 +++- src/ScholarlyArticle.php | 1637 +++++++++++++- src/School.php | 943 +++++++- src/ScreeningEvent.php | 717 +++++- src/Sculpture.php | 1511 ++++++++++++- src/SeaBodyOfWater.php | 674 +++++- src/SearchAction.php | 371 +++- src/SearchResultsPage.php | 1682 +++++++++++++- src/Season.php | 1511 ++++++++++++- src/Seat.php | 192 +- src/SelfStorage.php | 1329 ++++++++++- src/SellAction.php | 447 +++- src/SendAction.php | 402 +++- src/Series.php | 192 +- src/Service.php | 192 +- src/ServiceChannel.php | 192 +- src/ShareAction.php | 433 +++- src/ShoeStore.php | 1330 ++++++++++- src/ShoppingCenter.php | 1329 ++++++++++- src/SingleFamilyResidence.php | 736 ++++++- src/SiteNavigationElement.php | 1512 ++++++++++++- src/SkiResort.php | 1330 ++++++++++- src/SocialEvent.php | 717 +++++- src/SocialMediaPosting.php | 1637 +++++++++++++- src/SoftwareApplication.php | 1511 ++++++++++++- src/SoftwareSourceCode.php | 1511 ++++++++++++- src/SomeProducts.php | 726 +++++- src/SpeakableSpecification.php | 192 +- src/Specialty.php | 193 +- src/SportingGoodsStore.php | 1330 ++++++++++- src/SportsActivityLocation.php | 1329 ++++++++++- src/SportsClub.php | 1330 ++++++++++- src/SportsEvent.php | 717 +++++- src/SportsOrganization.php | 928 +++++++- src/SportsTeam.php | 943 +++++++- src/SpreadsheetDigitalDocument.php | 1528 ++++++++++++- src/StadiumOrArena.php | 1332 ++++++++++- src/State.php | 673 +++++- src/SteeringPositionValue.php | 321 ++- src/Store.php | 1329 ++++++++++- src/StructuredValue.php | 192 +- src/SubscribeAction.php | 372 +++- src/SubwayStation.php | 702 +++++- src/Suite.php | 735 ++++++- src/SuspendAction.php | 372 +++- src/Synagogue.php | 703 +++++- src/TVClip.php | 1644 +++++++++++++- src/TVEpisode.php | 1659 +++++++++++++- src/TVSeason.php | 1675 +++++++++++++- src/TVSeries.php | 1578 +++++++++++++- src/Table.php | 1512 ++++++++++++- src/TakeAction.php | 402 +++- src/TattooParlor.php | 1330 ++++++++++- src/Taxi.php | 531 ++++- src/TaxiReservation.php | 399 +++- src/TaxiService.php | 531 ++++- src/TaxiStand.php | 702 +++++- src/TechArticle.php | 1637 +++++++++++++- src/TelevisionChannel.php | 281 ++- src/TelevisionStation.php | 1329 ++++++++++- src/TennisComplex.php | 1330 ++++++++++- src/TextDigitalDocument.php | 1528 ++++++++++++- src/TheaterEvent.php | 717 +++++- src/TheaterGroup.php | 929 +++++++- src/Thing.php | 4 +- src/Ticket.php | 192 +- src/TieAction.php | 372 +++- src/TipAction.php | 447 +++- src/TireShop.php | 1330 ++++++++++- src/TouristAttraction.php | 672 +++++- src/TouristInformationCenter.php | 1329 ++++++++++- src/ToyStore.php | 1330 ++++++++++- src/TrackAction.php | 372 +++- src/TradeAction.php | 371 +++- src/TrainReservation.php | 399 +++- src/TrainStation.php | 702 +++++- src/TrainTrip.php | 253 ++- src/TransferAction.php | 371 +++- src/TravelAction.php | 402 +++- src/TravelAgency.php | 1329 ++++++++++- src/Trip.php | 192 +- src/TypeAndQuantityNode.php | 193 +- src/UnRegisterAction.php | 372 +++- src/UnitPriceSpecification.php | 359 ++- src/UpdateAction.php | 371 +++- src/UseAction.php | 404 +++- src/UserBlocks.php | 718 +++++- src/UserCheckins.php | 718 +++++- src/UserComments.php | 718 +++++- src/UserDownloads.php | 718 +++++- src/UserInteraction.php | 717 +++++- src/UserLikes.php | 718 +++++- src/UserPageVisits.php | 718 +++++- src/UserPlays.php | 718 +++++- src/UserPlusOnes.php | 718 +++++- src/UserTweets.php | 718 +++++- src/Vehicle.php | 726 +++++- src/VideoGallery.php | 1683 +++++++++++++- src/VideoGame.php | 1938 ++++++++++++++++- src/VideoGameClip.php | 1644 +++++++++++++- src/VideoGameSeries.php | 1576 +++++++++++++- src/VideoObject.php | 1763 ++++++++++++++- src/ViewAction.php | 404 +++- src/VisualArtsEvent.php | 717 +++++- src/VisualArtwork.php | 1511 ++++++++++++- src/Volcano.php | 673 +++++- src/VoteAction.php | 401 +++- src/WPAdBlock.php | 1512 ++++++++++++- src/WPFooter.php | 1512 ++++++++++++- src/WPHeader.php | 1512 ++++++++++++- src/WPSideBar.php | 1512 ++++++++++++- src/WantAction.php | 373 +++- src/WarrantyPromise.php | 193 +- src/WarrantyScope.php | 193 +- src/WatchAction.php | 404 +++- src/Waterfall.php | 674 +++++- src/WearAction.php | 405 +++- src/WebApplication.php | 1863 +++++++++++++++- src/WebPage.php | 1511 ++++++++++++- src/WebPageElement.php | 1511 ++++++++++++- src/WebSite.php | 1511 ++++++++++++- src/WholesaleStore.php | 1330 ++++++++++- src/WinAction.php | 372 +++- src/Winery.php | 1407 +++++++++++- src/WorkersUnion.php | 928 +++++++- src/WriteAction.php | 372 +++- src/Zoo.php | 702 +++++- 1228 files changed, 573449 insertions(+), 1252 deletions(-) create mode 100644 src/Contracts/AMRadioChannelContract.php create mode 100644 src/Contracts/APIReferenceContract.php create mode 100644 src/Contracts/AboutPageContract.php create mode 100644 src/Contracts/AcceptActionContract.php create mode 100644 src/Contracts/AccommodationContract.php create mode 100644 src/Contracts/AccountingServiceContract.php create mode 100644 src/Contracts/AchieveActionContract.php create mode 100644 src/Contracts/ActionAccessSpecificationContract.php create mode 100644 src/Contracts/ActionContract.php create mode 100644 src/Contracts/ActionStatusTypeContract.php create mode 100644 src/Contracts/ActivateActionContract.php create mode 100644 src/Contracts/AddActionContract.php create mode 100644 src/Contracts/AdministrativeAreaContract.php create mode 100644 src/Contracts/AdultEntertainmentContract.php create mode 100644 src/Contracts/AggregateOfferContract.php create mode 100644 src/Contracts/AggregateRatingContract.php create mode 100644 src/Contracts/AgreeActionContract.php create mode 100644 src/Contracts/AirlineContract.php create mode 100644 src/Contracts/AirportContract.php create mode 100644 src/Contracts/AlignmentObjectContract.php create mode 100644 src/Contracts/AllocateActionContract.php create mode 100644 src/Contracts/AmusementParkContract.php create mode 100644 src/Contracts/AnimalShelterContract.php create mode 100644 src/Contracts/AnswerContract.php create mode 100644 src/Contracts/ApartmentComplexContract.php create mode 100644 src/Contracts/ApartmentContract.php create mode 100644 src/Contracts/AppendActionContract.php create mode 100644 src/Contracts/ApplyActionContract.php create mode 100644 src/Contracts/AquariumContract.php create mode 100644 src/Contracts/ArriveActionContract.php create mode 100644 src/Contracts/ArtGalleryContract.php create mode 100644 src/Contracts/ArticleContract.php create mode 100644 src/Contracts/AskActionContract.php create mode 100644 src/Contracts/AssessActionContract.php create mode 100644 src/Contracts/AssignActionContract.php create mode 100644 src/Contracts/AttorneyContract.php create mode 100644 src/Contracts/AudienceContract.php create mode 100644 src/Contracts/AudioObjectContract.php create mode 100644 src/Contracts/AuthorizeActionContract.php create mode 100644 src/Contracts/AutoBodyShopContract.php create mode 100644 src/Contracts/AutoDealerContract.php create mode 100644 src/Contracts/AutoPartsStoreContract.php create mode 100644 src/Contracts/AutoRentalContract.php create mode 100644 src/Contracts/AutoRepairContract.php create mode 100644 src/Contracts/AutoWashContract.php create mode 100644 src/Contracts/AutomatedTellerContract.php create mode 100644 src/Contracts/AutomotiveBusinessContract.php create mode 100644 src/Contracts/BakeryContract.php create mode 100644 src/Contracts/BankAccountContract.php create mode 100644 src/Contracts/BankOrCreditUnionContract.php create mode 100644 src/Contracts/BarOrPubContract.php create mode 100644 src/Contracts/BarcodeContract.php create mode 100644 src/Contracts/BeachContract.php create mode 100644 src/Contracts/BeautySalonContract.php create mode 100644 src/Contracts/BedAndBreakfastContract.php create mode 100644 src/Contracts/BedDetailsContract.php create mode 100644 src/Contracts/BedTypeContract.php create mode 100644 src/Contracts/BefriendActionContract.php create mode 100644 src/Contracts/BikeStoreContract.php create mode 100644 src/Contracts/BlogContract.php create mode 100644 src/Contracts/BlogPostingContract.php create mode 100644 src/Contracts/BoardingPolicyTypeContract.php create mode 100644 src/Contracts/BodyOfWaterContract.php create mode 100644 src/Contracts/BookContract.php create mode 100644 src/Contracts/BookFormatTypeContract.php create mode 100644 src/Contracts/BookSeriesContract.php create mode 100644 src/Contracts/BookStoreContract.php create mode 100644 src/Contracts/BookmarkActionContract.php create mode 100644 src/Contracts/BorrowActionContract.php create mode 100644 src/Contracts/BowlingAlleyContract.php create mode 100644 src/Contracts/BrandContract.php create mode 100644 src/Contracts/BreadcrumbListContract.php create mode 100644 src/Contracts/BreweryContract.php create mode 100644 src/Contracts/BridgeContract.php create mode 100644 src/Contracts/BroadcastChannelContract.php create mode 100644 src/Contracts/BroadcastEventContract.php create mode 100644 src/Contracts/BroadcastFrequencySpecificationContract.php create mode 100644 src/Contracts/BroadcastServiceContract.php create mode 100644 src/Contracts/BuddhistTempleContract.php create mode 100644 src/Contracts/BusReservationContract.php create mode 100644 src/Contracts/BusStationContract.php create mode 100644 src/Contracts/BusStopContract.php create mode 100644 src/Contracts/BusTripContract.php create mode 100644 src/Contracts/BusinessAudienceContract.php create mode 100644 src/Contracts/BusinessEntityTypeContract.php create mode 100644 src/Contracts/BusinessEventContract.php create mode 100644 src/Contracts/BusinessFunctionContract.php create mode 100644 src/Contracts/BuyActionContract.php create mode 100644 src/Contracts/CableOrSatelliteServiceContract.php create mode 100644 src/Contracts/CafeOrCoffeeShopContract.php create mode 100644 src/Contracts/CampgroundContract.php create mode 100644 src/Contracts/CampingPitchContract.php create mode 100644 src/Contracts/CanalContract.php create mode 100644 src/Contracts/CancelActionContract.php create mode 100644 src/Contracts/CarContract.php create mode 100644 src/Contracts/CasinoContract.php create mode 100644 src/Contracts/CatholicChurchContract.php create mode 100644 src/Contracts/CemeteryContract.php create mode 100644 src/Contracts/CheckActionContract.php create mode 100644 src/Contracts/CheckInActionContract.php create mode 100644 src/Contracts/CheckOutActionContract.php create mode 100644 src/Contracts/CheckoutPageContract.php create mode 100644 src/Contracts/ChildCareContract.php create mode 100644 src/Contracts/ChildrensEventContract.php create mode 100644 src/Contracts/ChooseActionContract.php create mode 100644 src/Contracts/ChurchContract.php create mode 100644 src/Contracts/CityContract.php create mode 100644 src/Contracts/CityHallContract.php create mode 100644 src/Contracts/CivicStructureContract.php create mode 100644 src/Contracts/ClaimReviewContract.php create mode 100644 src/Contracts/ClipContract.php create mode 100644 src/Contracts/ClothingStoreContract.php create mode 100644 src/Contracts/CodeContract.php create mode 100644 src/Contracts/CollectionPageContract.php create mode 100644 src/Contracts/CollegeOrUniversityContract.php create mode 100644 src/Contracts/ComedyClubContract.php create mode 100644 src/Contracts/ComedyEventContract.php create mode 100644 src/Contracts/CommentActionContract.php create mode 100644 src/Contracts/CommentContract.php create mode 100644 src/Contracts/CommunicateActionContract.php create mode 100644 src/Contracts/CompoundPriceSpecificationContract.php create mode 100644 src/Contracts/ComputerLanguageContract.php create mode 100644 src/Contracts/ComputerStoreContract.php create mode 100644 src/Contracts/ConfirmActionContract.php create mode 100644 src/Contracts/ConsumeActionContract.php create mode 100644 src/Contracts/ContactPageContract.php create mode 100644 src/Contracts/ContactPointContract.php create mode 100644 src/Contracts/ContactPointOptionContract.php create mode 100644 src/Contracts/ContinentContract.php create mode 100644 src/Contracts/ControlActionContract.php create mode 100644 src/Contracts/ConvenienceStoreContract.php create mode 100644 src/Contracts/ConversationContract.php create mode 100644 src/Contracts/CookActionContract.php create mode 100644 src/Contracts/CorporationContract.php create mode 100644 src/Contracts/CountryContract.php create mode 100644 src/Contracts/CourseContract.php create mode 100644 src/Contracts/CourseInstanceContract.php create mode 100644 src/Contracts/CourthouseContract.php create mode 100644 src/Contracts/CreateActionContract.php create mode 100644 src/Contracts/CreativeWorkContract.php create mode 100644 src/Contracts/CreativeWorkSeasonContract.php create mode 100644 src/Contracts/CreativeWorkSeriesContract.php create mode 100644 src/Contracts/CreditCardContract.php create mode 100644 src/Contracts/CrematoriumContract.php create mode 100644 src/Contracts/CurrencyConversionServiceContract.php create mode 100644 src/Contracts/DanceEventContract.php create mode 100644 src/Contracts/DanceGroupContract.php create mode 100644 src/Contracts/DataCatalogContract.php create mode 100644 src/Contracts/DataDownloadContract.php create mode 100644 src/Contracts/DataFeedContract.php create mode 100644 src/Contracts/DataFeedItemContract.php create mode 100644 src/Contracts/DatasetContract.php create mode 100644 src/Contracts/DatedMoneySpecificationContract.php create mode 100644 src/Contracts/DayOfWeekContract.php create mode 100644 src/Contracts/DaySpaContract.php create mode 100644 src/Contracts/DeactivateActionContract.php create mode 100644 src/Contracts/DefenceEstablishmentContract.php create mode 100644 src/Contracts/DeleteActionContract.php create mode 100644 src/Contracts/DeliveryChargeSpecificationContract.php create mode 100644 src/Contracts/DeliveryEventContract.php create mode 100644 src/Contracts/DeliveryMethodContract.php create mode 100644 src/Contracts/DemandContract.php create mode 100644 src/Contracts/DentistContract.php create mode 100644 src/Contracts/DepartActionContract.php create mode 100644 src/Contracts/DepartmentStoreContract.php create mode 100644 src/Contracts/DepositAccountContract.php create mode 100644 src/Contracts/DigitalDocumentContract.php create mode 100644 src/Contracts/DigitalDocumentPermissionContract.php create mode 100644 src/Contracts/DigitalDocumentPermissionTypeContract.php create mode 100644 src/Contracts/DisagreeActionContract.php create mode 100644 src/Contracts/DiscoverActionContract.php create mode 100644 src/Contracts/DiscussionForumPostingContract.php create mode 100644 src/Contracts/DislikeActionContract.php create mode 100644 src/Contracts/DistanceContract.php create mode 100644 src/Contracts/DistilleryContract.php create mode 100644 src/Contracts/DonateActionContract.php create mode 100644 src/Contracts/DownloadActionContract.php create mode 100644 src/Contracts/DrawActionContract.php create mode 100644 src/Contracts/DrinkActionContract.php create mode 100644 src/Contracts/DriveWheelConfigurationValueContract.php create mode 100644 src/Contracts/DryCleaningOrLaundryContract.php create mode 100644 src/Contracts/DurationContract.php create mode 100644 src/Contracts/EatActionContract.php create mode 100644 src/Contracts/EducationEventContract.php create mode 100644 src/Contracts/EducationalAudienceContract.php create mode 100644 src/Contracts/EducationalOrganizationContract.php create mode 100644 src/Contracts/ElectricianContract.php create mode 100644 src/Contracts/ElectronicsStoreContract.php create mode 100644 src/Contracts/ElementarySchoolContract.php create mode 100644 src/Contracts/EmailMessageContract.php create mode 100644 src/Contracts/EmbassyContract.php create mode 100644 src/Contracts/EmergencyServiceContract.php create mode 100644 src/Contracts/EmployeeRoleContract.php create mode 100644 src/Contracts/EmployerAggregateRatingContract.php create mode 100644 src/Contracts/EmploymentAgencyContract.php create mode 100644 src/Contracts/EndorseActionContract.php create mode 100644 src/Contracts/EndorsementRatingContract.php create mode 100644 src/Contracts/EnergyContract.php create mode 100644 src/Contracts/EngineSpecificationContract.php create mode 100644 src/Contracts/EntertainmentBusinessContract.php create mode 100644 src/Contracts/EntryPointContract.php create mode 100644 src/Contracts/EnumerationContract.php create mode 100644 src/Contracts/EpisodeContract.php create mode 100644 src/Contracts/EventContract.php create mode 100644 src/Contracts/EventReservationContract.php create mode 100644 src/Contracts/EventStatusTypeContract.php create mode 100644 src/Contracts/EventVenueContract.php create mode 100644 src/Contracts/ExerciseActionContract.php create mode 100644 src/Contracts/ExerciseGymContract.php create mode 100644 src/Contracts/ExhibitionEventContract.php create mode 100644 src/Contracts/FAQPageContract.php create mode 100644 src/Contracts/FMRadioChannelContract.php create mode 100644 src/Contracts/FastFoodRestaurantContract.php create mode 100644 src/Contracts/FestivalContract.php create mode 100644 src/Contracts/FilmActionContract.php create mode 100644 src/Contracts/FinancialProductContract.php create mode 100644 src/Contracts/FinancialServiceContract.php create mode 100644 src/Contracts/FindActionContract.php create mode 100644 src/Contracts/FireStationContract.php create mode 100644 src/Contracts/FlightContract.php create mode 100644 src/Contracts/FlightReservationContract.php create mode 100644 src/Contracts/FloristContract.php create mode 100644 src/Contracts/FollowActionContract.php create mode 100644 src/Contracts/FoodEstablishmentContract.php create mode 100644 src/Contracts/FoodEstablishmentReservationContract.php create mode 100644 src/Contracts/FoodEventContract.php create mode 100644 src/Contracts/FoodServiceContract.php create mode 100644 src/Contracts/FurnitureStoreContract.php create mode 100644 src/Contracts/GameContract.php create mode 100644 src/Contracts/GamePlayModeContract.php create mode 100644 src/Contracts/GameServerContract.php create mode 100644 src/Contracts/GameServerStatusContract.php create mode 100644 src/Contracts/GardenStoreContract.php create mode 100644 src/Contracts/GasStationContract.php create mode 100644 src/Contracts/GatedResidenceCommunityContract.php create mode 100644 src/Contracts/GenderTypeContract.php create mode 100644 src/Contracts/GeneralContractorContract.php create mode 100644 src/Contracts/GeoCircleContract.php create mode 100644 src/Contracts/GeoCoordinatesContract.php create mode 100644 src/Contracts/GeoShapeContract.php create mode 100644 src/Contracts/GiveActionContract.php create mode 100644 src/Contracts/GolfCourseContract.php create mode 100644 src/Contracts/GovernmentBuildingContract.php create mode 100644 src/Contracts/GovernmentOfficeContract.php create mode 100644 src/Contracts/GovernmentOrganizationContract.php create mode 100644 src/Contracts/GovernmentPermitContract.php create mode 100644 src/Contracts/GovernmentServiceContract.php create mode 100644 src/Contracts/GroceryStoreContract.php create mode 100644 src/Contracts/HVACBusinessContract.php create mode 100644 src/Contracts/HairSalonContract.php create mode 100644 src/Contracts/HardwareStoreContract.php create mode 100644 src/Contracts/HealthAndBeautyBusinessContract.php create mode 100644 src/Contracts/HealthClubContract.php create mode 100644 src/Contracts/HighSchoolContract.php create mode 100644 src/Contracts/HinduTempleContract.php create mode 100644 src/Contracts/HobbyShopContract.php create mode 100644 src/Contracts/HomeAndConstructionBusinessContract.php create mode 100644 src/Contracts/HomeGoodsStoreContract.php create mode 100644 src/Contracts/HospitalContract.php create mode 100644 src/Contracts/HostelContract.php create mode 100644 src/Contracts/HotelContract.php create mode 100644 src/Contracts/HotelRoomContract.php create mode 100644 src/Contracts/HouseContract.php create mode 100644 src/Contracts/HousePainterContract.php create mode 100644 src/Contracts/HowToContract.php create mode 100644 src/Contracts/HowToDirectionContract.php create mode 100644 src/Contracts/HowToItemContract.php create mode 100644 src/Contracts/HowToSectionContract.php create mode 100644 src/Contracts/HowToStepContract.php create mode 100644 src/Contracts/HowToSupplyContract.php create mode 100644 src/Contracts/HowToTipContract.php create mode 100644 src/Contracts/HowToToolContract.php create mode 100644 src/Contracts/IceCreamShopContract.php create mode 100644 src/Contracts/IgnoreActionContract.php create mode 100644 src/Contracts/ImageGalleryContract.php create mode 100644 src/Contracts/ImageObjectContract.php create mode 100644 src/Contracts/IndividualProductContract.php create mode 100644 src/Contracts/InformActionContract.php create mode 100644 src/Contracts/InsertActionContract.php create mode 100644 src/Contracts/InstallActionContract.php create mode 100644 src/Contracts/InsuranceAgencyContract.php create mode 100644 src/Contracts/IntangibleContract.php create mode 100644 src/Contracts/InteractActionContract.php create mode 100644 src/Contracts/InteractionCounterContract.php create mode 100644 src/Contracts/InternetCafeContract.php create mode 100644 src/Contracts/InvestmentOrDepositContract.php create mode 100644 src/Contracts/InviteActionContract.php create mode 100644 src/Contracts/InvoiceContract.php create mode 100644 src/Contracts/ItemAvailabilityContract.php create mode 100644 src/Contracts/ItemListContract.php create mode 100644 src/Contracts/ItemListOrderTypeContract.php create mode 100644 src/Contracts/ItemPageContract.php create mode 100644 src/Contracts/JewelryStoreContract.php create mode 100644 src/Contracts/JobPostingContract.php create mode 100644 src/Contracts/JoinActionContract.php create mode 100644 src/Contracts/LakeBodyOfWaterContract.php create mode 100644 src/Contracts/LandformContract.php create mode 100644 src/Contracts/LandmarksOrHistoricalBuildingsContract.php create mode 100644 src/Contracts/LanguageContract.php create mode 100644 src/Contracts/LeaveActionContract.php create mode 100644 src/Contracts/LegalServiceContract.php create mode 100644 src/Contracts/LegislativeBuildingContract.php create mode 100644 src/Contracts/LendActionContract.php create mode 100644 src/Contracts/LibraryContract.php create mode 100644 src/Contracts/LikeActionContract.php create mode 100644 src/Contracts/LiquorStoreContract.php create mode 100644 src/Contracts/ListItemContract.php create mode 100644 src/Contracts/ListenActionContract.php create mode 100644 src/Contracts/LiteraryEventContract.php create mode 100644 src/Contracts/LiveBlogPostingContract.php create mode 100644 src/Contracts/LoanOrCreditContract.php create mode 100644 src/Contracts/LocalBusinessContract.php create mode 100644 src/Contracts/LocationFeatureSpecificationContract.php create mode 100644 src/Contracts/LockerDeliveryContract.php create mode 100644 src/Contracts/LocksmithContract.php create mode 100644 src/Contracts/LodgingBusinessContract.php create mode 100644 src/Contracts/LodgingReservationContract.php create mode 100644 src/Contracts/LoseActionContract.php create mode 100644 src/Contracts/MapCategoryTypeContract.php create mode 100644 src/Contracts/MapContract.php create mode 100644 src/Contracts/MarryActionContract.php create mode 100644 src/Contracts/MassContract.php create mode 100644 src/Contracts/MediaObjectContract.php create mode 100644 src/Contracts/MediaSubscriptionContract.php create mode 100644 src/Contracts/MedicalOrganizationContract.php create mode 100644 src/Contracts/MeetingRoomContract.php create mode 100644 src/Contracts/MensClothingStoreContract.php create mode 100644 src/Contracts/MenuContract.php create mode 100644 src/Contracts/MenuItemContract.php create mode 100644 src/Contracts/MenuSectionContract.php create mode 100644 src/Contracts/MessageContract.php create mode 100644 src/Contracts/MiddleSchoolContract.php create mode 100644 src/Contracts/MobileApplicationContract.php create mode 100644 src/Contracts/MobilePhoneStoreContract.php create mode 100644 src/Contracts/MonetaryAmountContract.php create mode 100644 src/Contracts/MonetaryAmountDistributionContract.php create mode 100644 src/Contracts/MosqueContract.php create mode 100644 src/Contracts/MotelContract.php create mode 100644 src/Contracts/MotorcycleDealerContract.php create mode 100644 src/Contracts/MotorcycleRepairContract.php create mode 100644 src/Contracts/MountainContract.php create mode 100644 src/Contracts/MoveActionContract.php create mode 100644 src/Contracts/MovieClipContract.php create mode 100644 src/Contracts/MovieContract.php create mode 100644 src/Contracts/MovieRentalStoreContract.php create mode 100644 src/Contracts/MovieSeriesContract.php create mode 100644 src/Contracts/MovieTheaterContract.php create mode 100644 src/Contracts/MovingCompanyContract.php create mode 100644 src/Contracts/MuseumContract.php create mode 100644 src/Contracts/MusicAlbumContract.php create mode 100644 src/Contracts/MusicAlbumProductionTypeContract.php create mode 100644 src/Contracts/MusicAlbumReleaseTypeContract.php create mode 100644 src/Contracts/MusicCompositionContract.php create mode 100644 src/Contracts/MusicEventContract.php create mode 100644 src/Contracts/MusicGroupContract.php create mode 100644 src/Contracts/MusicPlaylistContract.php create mode 100644 src/Contracts/MusicRecordingContract.php create mode 100644 src/Contracts/MusicReleaseContract.php create mode 100644 src/Contracts/MusicReleaseFormatTypeContract.php create mode 100644 src/Contracts/MusicStoreContract.php create mode 100644 src/Contracts/MusicVenueContract.php create mode 100644 src/Contracts/MusicVideoObjectContract.php create mode 100644 src/Contracts/NGOContract.php create mode 100644 src/Contracts/NailSalonContract.php create mode 100644 src/Contracts/NewsArticleContract.php create mode 100644 src/Contracts/NightClubContract.php create mode 100644 src/Contracts/NotaryContract.php create mode 100644 src/Contracts/NoteDigitalDocumentContract.php create mode 100644 src/Contracts/NutritionInformationContract.php create mode 100644 src/Contracts/OccupationContract.php create mode 100644 src/Contracts/OceanBodyOfWaterContract.php create mode 100644 src/Contracts/OfferCatalogContract.php create mode 100644 src/Contracts/OfferContract.php create mode 100644 src/Contracts/OfferItemConditionContract.php create mode 100644 src/Contracts/OfficeEquipmentStoreContract.php create mode 100644 src/Contracts/OnDemandEventContract.php create mode 100644 src/Contracts/OpeningHoursSpecificationContract.php create mode 100644 src/Contracts/OrderActionContract.php create mode 100644 src/Contracts/OrderContract.php create mode 100644 src/Contracts/OrderItemContract.php create mode 100644 src/Contracts/OrderStatusContract.php create mode 100644 src/Contracts/OrganizationContract.php create mode 100644 src/Contracts/OrganizationRoleContract.php create mode 100644 src/Contracts/OrganizeActionContract.php create mode 100644 src/Contracts/OutletStoreContract.php create mode 100644 src/Contracts/OwnershipInfoContract.php create mode 100644 src/Contracts/PaintActionContract.php create mode 100644 src/Contracts/PaintingContract.php create mode 100644 src/Contracts/ParcelDeliveryContract.php create mode 100644 src/Contracts/ParcelServiceContract.php create mode 100644 src/Contracts/ParentAudienceContract.php create mode 100644 src/Contracts/ParkContract.php create mode 100644 src/Contracts/ParkingFacilityContract.php create mode 100644 src/Contracts/PawnShopContract.php create mode 100644 src/Contracts/PayActionContract.php create mode 100644 src/Contracts/PaymentCardContract.php create mode 100644 src/Contracts/PaymentChargeSpecificationContract.php create mode 100644 src/Contracts/PaymentMethodContract.php create mode 100644 src/Contracts/PaymentServiceContract.php create mode 100644 src/Contracts/PaymentStatusTypeContract.php create mode 100644 src/Contracts/PeopleAudienceContract.php create mode 100644 src/Contracts/PerformActionContract.php create mode 100644 src/Contracts/PerformanceRoleContract.php create mode 100644 src/Contracts/PerformingArtsTheaterContract.php create mode 100644 src/Contracts/PerformingGroupContract.php create mode 100644 src/Contracts/PeriodicalContract.php create mode 100644 src/Contracts/PermitContract.php create mode 100644 src/Contracts/PersonContract.php create mode 100644 src/Contracts/PetStoreContract.php create mode 100644 src/Contracts/PharmacyContract.php create mode 100644 src/Contracts/PhotographActionContract.php create mode 100644 src/Contracts/PhotographContract.php create mode 100644 src/Contracts/PhysicianContract.php create mode 100644 src/Contracts/PlaceContract.php create mode 100644 src/Contracts/PlaceOfWorshipContract.php create mode 100644 src/Contracts/PlanActionContract.php create mode 100644 src/Contracts/PlayActionContract.php create mode 100644 src/Contracts/PlaygroundContract.php create mode 100644 src/Contracts/PlumberContract.php create mode 100644 src/Contracts/PoliceStationContract.php create mode 100644 src/Contracts/PondContract.php create mode 100644 src/Contracts/PostOfficeContract.php create mode 100644 src/Contracts/PostalAddressContract.php create mode 100644 src/Contracts/PreOrderActionContract.php create mode 100644 src/Contracts/PrependActionContract.php create mode 100644 src/Contracts/PreschoolContract.php create mode 100644 src/Contracts/PresentationDigitalDocumentContract.php create mode 100644 src/Contracts/PriceSpecificationContract.php create mode 100644 src/Contracts/ProductContract.php create mode 100644 src/Contracts/ProductModelContract.php create mode 100644 src/Contracts/ProfessionalServiceContract.php create mode 100644 src/Contracts/ProfilePageContract.php create mode 100644 src/Contracts/ProgramMembershipContract.php create mode 100644 src/Contracts/PropertyValueContract.php create mode 100644 src/Contracts/PropertyValueSpecificationContract.php create mode 100644 src/Contracts/PublicSwimmingPoolContract.php create mode 100644 src/Contracts/PublicationEventContract.php create mode 100644 src/Contracts/PublicationIssueContract.php create mode 100644 src/Contracts/PublicationVolumeContract.php create mode 100644 src/Contracts/QAPageContract.php create mode 100644 src/Contracts/QualitativeValueContract.php create mode 100644 src/Contracts/QuantitativeValueContract.php create mode 100644 src/Contracts/QuantitativeValueDistributionContract.php create mode 100644 src/Contracts/QuantityContract.php create mode 100644 src/Contracts/QuestionContract.php create mode 100644 src/Contracts/QuoteActionContract.php create mode 100644 src/Contracts/RVParkContract.php create mode 100644 src/Contracts/RadioChannelContract.php create mode 100644 src/Contracts/RadioClipContract.php create mode 100644 src/Contracts/RadioEpisodeContract.php create mode 100644 src/Contracts/RadioSeasonContract.php create mode 100644 src/Contracts/RadioSeriesContract.php create mode 100644 src/Contracts/RadioStationContract.php create mode 100644 src/Contracts/RatingContract.php create mode 100644 src/Contracts/ReactActionContract.php create mode 100644 src/Contracts/ReadActionContract.php create mode 100644 src/Contracts/RealEstateAgentContract.php create mode 100644 src/Contracts/ReceiveActionContract.php create mode 100644 src/Contracts/RecipeContract.php create mode 100644 src/Contracts/RecyclingCenterContract.php create mode 100644 src/Contracts/RegisterActionContract.php create mode 100644 src/Contracts/RejectActionContract.php create mode 100644 src/Contracts/RentActionContract.php create mode 100644 src/Contracts/RentalCarReservationContract.php create mode 100644 src/Contracts/ReplaceActionContract.php create mode 100644 src/Contracts/ReplyActionContract.php create mode 100644 src/Contracts/ReportContract.php create mode 100644 src/Contracts/ReservationContract.php create mode 100644 src/Contracts/ReservationPackageContract.php create mode 100644 src/Contracts/ReservationStatusTypeContract.php create mode 100644 src/Contracts/ReserveActionContract.php create mode 100644 src/Contracts/ReservoirContract.php create mode 100644 src/Contracts/ResidenceContract.php create mode 100644 src/Contracts/ResortContract.php create mode 100644 src/Contracts/RestaurantContract.php create mode 100644 src/Contracts/RestrictedDietContract.php create mode 100644 src/Contracts/ResumeActionContract.php create mode 100644 src/Contracts/ReturnActionContract.php create mode 100644 src/Contracts/ReviewActionContract.php create mode 100644 src/Contracts/ReviewContract.php create mode 100644 src/Contracts/RiverBodyOfWaterContract.php create mode 100644 src/Contracts/RoleContract.php create mode 100644 src/Contracts/RoofingContractorContract.php create mode 100644 src/Contracts/RoomContract.php create mode 100644 src/Contracts/RsvpActionContract.php create mode 100644 src/Contracts/RsvpResponseTypeContract.php create mode 100644 src/Contracts/SaleEventContract.php create mode 100644 src/Contracts/ScheduleActionContract.php create mode 100644 src/Contracts/ScholarlyArticleContract.php create mode 100644 src/Contracts/SchoolContract.php create mode 100644 src/Contracts/ScreeningEventContract.php create mode 100644 src/Contracts/SculptureContract.php create mode 100644 src/Contracts/SeaBodyOfWaterContract.php create mode 100644 src/Contracts/SearchActionContract.php create mode 100644 src/Contracts/SearchResultsPageContract.php create mode 100644 src/Contracts/SeasonContract.php create mode 100644 src/Contracts/SeatContract.php create mode 100644 src/Contracts/SelfStorageContract.php create mode 100644 src/Contracts/SellActionContract.php create mode 100644 src/Contracts/SendActionContract.php create mode 100644 src/Contracts/SeriesContract.php create mode 100644 src/Contracts/ServiceChannelContract.php create mode 100644 src/Contracts/ServiceContract.php create mode 100644 src/Contracts/ShareActionContract.php create mode 100644 src/Contracts/ShoeStoreContract.php create mode 100644 src/Contracts/ShoppingCenterContract.php create mode 100644 src/Contracts/SingleFamilyResidenceContract.php create mode 100644 src/Contracts/SiteNavigationElementContract.php create mode 100644 src/Contracts/SkiResortContract.php create mode 100644 src/Contracts/SocialEventContract.php create mode 100644 src/Contracts/SocialMediaPostingContract.php create mode 100644 src/Contracts/SoftwareApplicationContract.php create mode 100644 src/Contracts/SoftwareSourceCodeContract.php create mode 100644 src/Contracts/SomeProductsContract.php create mode 100644 src/Contracts/SpeakableSpecificationContract.php create mode 100644 src/Contracts/SpecialtyContract.php create mode 100644 src/Contracts/SportingGoodsStoreContract.php create mode 100644 src/Contracts/SportsActivityLocationContract.php create mode 100644 src/Contracts/SportsClubContract.php create mode 100644 src/Contracts/SportsEventContract.php create mode 100644 src/Contracts/SportsOrganizationContract.php create mode 100644 src/Contracts/SportsTeamContract.php create mode 100644 src/Contracts/SpreadsheetDigitalDocumentContract.php create mode 100644 src/Contracts/StadiumOrArenaContract.php create mode 100644 src/Contracts/StateContract.php create mode 100644 src/Contracts/SteeringPositionValueContract.php create mode 100644 src/Contracts/StoreContract.php create mode 100644 src/Contracts/StructuredValueContract.php create mode 100644 src/Contracts/SubscribeActionContract.php create mode 100644 src/Contracts/SubwayStationContract.php create mode 100644 src/Contracts/SuiteContract.php create mode 100644 src/Contracts/SuspendActionContract.php create mode 100644 src/Contracts/SynagogueContract.php create mode 100644 src/Contracts/TVClipContract.php create mode 100644 src/Contracts/TVEpisodeContract.php create mode 100644 src/Contracts/TVSeasonContract.php create mode 100644 src/Contracts/TVSeriesContract.php create mode 100644 src/Contracts/TableContract.php create mode 100644 src/Contracts/TakeActionContract.php create mode 100644 src/Contracts/TattooParlorContract.php create mode 100644 src/Contracts/TaxiContract.php create mode 100644 src/Contracts/TaxiReservationContract.php create mode 100644 src/Contracts/TaxiServiceContract.php create mode 100644 src/Contracts/TaxiStandContract.php create mode 100644 src/Contracts/TechArticleContract.php create mode 100644 src/Contracts/TelevisionChannelContract.php create mode 100644 src/Contracts/TelevisionStationContract.php create mode 100644 src/Contracts/TennisComplexContract.php create mode 100644 src/Contracts/TextDigitalDocumentContract.php create mode 100644 src/Contracts/TheaterEventContract.php create mode 100644 src/Contracts/TheaterGroupContract.php create mode 100644 src/Contracts/ThingContract.php create mode 100644 src/Contracts/TicketContract.php create mode 100644 src/Contracts/TieActionContract.php create mode 100644 src/Contracts/TipActionContract.php create mode 100644 src/Contracts/TireShopContract.php create mode 100644 src/Contracts/TouristAttractionContract.php create mode 100644 src/Contracts/TouristInformationCenterContract.php create mode 100644 src/Contracts/ToyStoreContract.php create mode 100644 src/Contracts/TrackActionContract.php create mode 100644 src/Contracts/TradeActionContract.php create mode 100644 src/Contracts/TrainReservationContract.php create mode 100644 src/Contracts/TrainStationContract.php create mode 100644 src/Contracts/TrainTripContract.php create mode 100644 src/Contracts/TransferActionContract.php create mode 100644 src/Contracts/TravelActionContract.php create mode 100644 src/Contracts/TravelAgencyContract.php create mode 100644 src/Contracts/TripContract.php create mode 100644 src/Contracts/TypeAndQuantityNodeContract.php create mode 100644 src/Contracts/UnRegisterActionContract.php create mode 100644 src/Contracts/UnitPriceSpecificationContract.php create mode 100644 src/Contracts/UpdateActionContract.php create mode 100644 src/Contracts/UseActionContract.php create mode 100644 src/Contracts/UserBlocksContract.php create mode 100644 src/Contracts/UserCheckinsContract.php create mode 100644 src/Contracts/UserCommentsContract.php create mode 100644 src/Contracts/UserDownloadsContract.php create mode 100644 src/Contracts/UserInteractionContract.php create mode 100644 src/Contracts/UserLikesContract.php create mode 100644 src/Contracts/UserPageVisitsContract.php create mode 100644 src/Contracts/UserPlaysContract.php create mode 100644 src/Contracts/UserPlusOnesContract.php create mode 100644 src/Contracts/UserTweetsContract.php create mode 100644 src/Contracts/VehicleContract.php create mode 100644 src/Contracts/VideoGalleryContract.php create mode 100644 src/Contracts/VideoGameClipContract.php create mode 100644 src/Contracts/VideoGameContract.php create mode 100644 src/Contracts/VideoGameSeriesContract.php create mode 100644 src/Contracts/VideoObjectContract.php create mode 100644 src/Contracts/ViewActionContract.php create mode 100644 src/Contracts/VisualArtsEventContract.php create mode 100644 src/Contracts/VisualArtworkContract.php create mode 100644 src/Contracts/VolcanoContract.php create mode 100644 src/Contracts/VoteActionContract.php create mode 100644 src/Contracts/WPAdBlockContract.php create mode 100644 src/Contracts/WPFooterContract.php create mode 100644 src/Contracts/WPHeaderContract.php create mode 100644 src/Contracts/WPSideBarContract.php create mode 100644 src/Contracts/WantActionContract.php create mode 100644 src/Contracts/WarrantyPromiseContract.php create mode 100644 src/Contracts/WarrantyScopeContract.php create mode 100644 src/Contracts/WatchActionContract.php create mode 100644 src/Contracts/WaterfallContract.php create mode 100644 src/Contracts/WearActionContract.php create mode 100644 src/Contracts/WebApplicationContract.php create mode 100644 src/Contracts/WebPageContract.php create mode 100644 src/Contracts/WebPageElementContract.php create mode 100644 src/Contracts/WebSiteContract.php create mode 100644 src/Contracts/WholesaleStoreContract.php create mode 100644 src/Contracts/WinActionContract.php create mode 100644 src/Contracts/WineryContract.php create mode 100644 src/Contracts/WorkersUnionContract.php create mode 100644 src/Contracts/WriteActionContract.php create mode 100644 src/Contracts/ZooContract.php diff --git a/src/AMRadioChannel.php b/src/AMRadioChannel.php index 9b2fd3f79..bb48597df 100644 --- a/src/AMRadioChannel.php +++ b/src/AMRadioChannel.php @@ -2,13 +2,291 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\RadioChannelContract; +use \Spatie\SchemaOrg\Contracts\BroadcastChannelContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A radio channel that uses AM. * * @see http://schema.org/AMRadioChannel * - * @mixin \Spatie\SchemaOrg\RadioChannel */ -class AMRadioChannel extends BaseType +class AMRadioChannel extends BaseType implements RadioChannelContract, BroadcastChannelContract, IntangibleContract, ThingContract { + /** + * The unique address by which the BroadcastService can be identified in a + * provider lineup. In US, this is typically a number. + * + * @param string|string[] $broadcastChannelId + * + * @return static + * + * @see http://schema.org/broadcastChannelId + */ + public function broadcastChannelId($broadcastChannelId) + { + return $this->setProperty('broadcastChannelId', $broadcastChannelId); + } + + /** + * The frequency used for over-the-air broadcasts. Numeric values or simple + * ranges e.g. 87-99. In addition a shortcut idiom is supported for + * frequences of AM and FM radio channels, e.g. "87 FM". + * + * @param BroadcastFrequencySpecification|BroadcastFrequencySpecification[]|string|string[] $broadcastFrequency + * + * @return static + * + * @see http://schema.org/broadcastFrequency + */ + public function broadcastFrequency($broadcastFrequency) + { + return $this->setProperty('broadcastFrequency', $broadcastFrequency); + } + + /** + * The type of service required to have access to the channel (e.g. Standard + * or Premium). + * + * @param string|string[] $broadcastServiceTier + * + * @return static + * + * @see http://schema.org/broadcastServiceTier + */ + public function broadcastServiceTier($broadcastServiceTier) + { + return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/APIReference.php b/src/APIReference.php index 6d41393ce..7ab5bc980 100644 --- a/src/APIReference.php +++ b/src/APIReference.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TechArticleContract; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Reference documentation for application programming interfaces (APIs). * * @see http://schema.org/APIReference * - * @mixin \Spatie\SchemaOrg\TechArticle */ -class APIReference extends BaseType +class APIReference extends BaseType implements TechArticleContract, ArticleContract, CreativeWorkContract, ThingContract { /** * Library file name e.g., mscorlib.dll, system.web.dll. @@ -81,4 +85,1663 @@ public function targetPlatform($targetPlatform) return $this->setProperty('targetPlatform', $targetPlatform); } + /** + * Prerequisites needed to fulfill steps in article. + * + * @param string|string[] $dependencies + * + * @return static + * + * @see http://schema.org/dependencies + */ + public function dependencies($dependencies) + { + return $this->setProperty('dependencies', $dependencies); + } + + /** + * Proficiency needed for this content; expected values: 'Beginner', + * 'Expert'. + * + * @param string|string[] $proficiencyLevel + * + * @return static + * + * @see http://schema.org/proficiencyLevel + */ + public function proficiencyLevel($proficiencyLevel) + { + return $this->setProperty('proficiencyLevel', $proficiencyLevel); + } + + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AboutPage.php b/src/AboutPage.php index 281facff4..da917d9f9 100644 --- a/src/AboutPage.php +++ b/src/AboutPage.php @@ -2,13 +2,1691 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web page type: About page. * * @see http://schema.org/AboutPage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class AboutPage extends BaseType +class AboutPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AcceptAction.php b/src/AcceptAction.php index 3ae318df4..9f2495c97 100644 --- a/src/AcceptAction.php +++ b/src/AcceptAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AllocateActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of committing to/adopting an object. * @@ -11,8 +16,372 @@ * * @see http://schema.org/AcceptAction * - * @mixin \Spatie\SchemaOrg\AllocateAction */ -class AcceptAction extends BaseType +class AcceptAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Accommodation.php b/src/Accommodation.php index ca2f92a09..c10ba9806 100644 --- a/src/Accommodation.php +++ b/src/Accommodation.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An accommodation is a place that can accommodate human beings, e.g. a hotel * room, a camping pitch, or a meeting room. Many accommodations are for @@ -14,9 +17,8 @@ * * @see http://schema.org/Accommodation * - * @mixin \Spatie\SchemaOrg\Place */ -class Accommodation extends BaseType +class Accommodation extends BaseType implements PlaceContract, ThingContract { /** * An amenity feature (e.g. a characteristic or service) of the @@ -97,4 +99,670 @@ public function petsAllowed($petsAllowed) return $this->setProperty('petsAllowed', $petsAllowed); } + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AccountingService.php b/src/AccountingService.php index edf1cb0bb..d2d6dc17a 100644 --- a/src/AccountingService.php +++ b/src/AccountingService.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Accountancy business. * @@ -10,8 +16,1343 @@ * * @see http://schema.org/AccountingService * - * @mixin \Spatie\SchemaOrg\FinancialService */ -class AccountingService extends BaseType +class AccountingService extends BaseType implements FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AchieveAction.php b/src/AchieveAction.php index cff071464..2c7ee7dcc 100644 --- a/src/AchieveAction.php +++ b/src/AchieveAction.php @@ -2,14 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of accomplishing something via previous efforts. It is an * instantaneous action rather than an ongoing process. * * @see http://schema.org/AchieveAction * - * @mixin \Spatie\SchemaOrg\Action */ -class AchieveAction extends BaseType +class AchieveAction extends BaseType implements ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Action.php b/src/Action.php index 556eafa5f..f540f83d0 100644 --- a/src/Action.php +++ b/src/Action.php @@ -2,6 +2,8 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An action performed by a direct agent and indirect participants upon a direct * object. Optionally happens at a location with the help of an inanimate @@ -14,9 +16,8 @@ * * @see http://schema.org/Action * - * @mixin \Spatie\SchemaOrg\Thing */ -class Action extends BaseType +class Action extends BaseType implements ThingContract { /** * Indicates the current disposition of the Action. @@ -197,4 +198,190 @@ public function target($target) return $this->setProperty('target', $target); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ActionAccessSpecification.php b/src/ActionAccessSpecification.php index 11ac09328..6c580a4bf 100644 --- a/src/ActionAccessSpecification.php +++ b/src/ActionAccessSpecification.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A set of requirements that a must be fulfilled in order to perform an Action. * * @see http://schema.org/ActionAccessSpecification * - * @mixin \Spatie\SchemaOrg\Intangible */ -class ActionAccessSpecification extends BaseType +class ActionAccessSpecification extends BaseType implements IntangibleContract, ThingContract { /** * @@ -95,4 +97,190 @@ public function requiresSubscription($requiresSubscription) return $this->setProperty('requiresSubscription', $requiresSubscription); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ActionStatusType.php b/src/ActionStatusType.php index 56bc842c3..c43eb9a67 100644 --- a/src/ActionStatusType.php +++ b/src/ActionStatusType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The status of an Action. * * @see http://schema.org/ActionStatusType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class ActionStatusType extends BaseType +class ActionStatusType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * An in-progress action (e.g, while watching the movie, or driving to a @@ -41,4 +44,190 @@ class ActionStatusType extends BaseType */ const PotentialActionStatus = 'http://schema.org/PotentialActionStatus'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ActivateAction.php b/src/ActivateAction.php index 5a5553299..8e5f48516 100644 --- a/src/ActivateAction.php +++ b/src/ActivateAction.php @@ -2,14 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ControlActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of starting or activating a device or application (e.g. starting a * timer or turning on a flashlight). * * @see http://schema.org/ActivateAction * - * @mixin \Spatie\SchemaOrg\ControlAction */ -class ActivateAction extends BaseType +class ActivateAction extends BaseType implements ControlActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AddAction.php b/src/AddAction.php index 3ce4446e3..7b5b31f8f 100644 --- a/src/AddAction.php +++ b/src/AddAction.php @@ -2,13 +2,409 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of editing by adding an object to a collection. * * @see http://schema.org/AddAction * - * @mixin \Spatie\SchemaOrg\UpdateAction */ -class AddAction extends BaseType +class AddAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract { + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $collection + * + * @return static + * + * @see http://schema.org/collection + */ + public function collection($collection) + { + return $this->setProperty('collection', $collection); + } + + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $targetCollection + * + * @return static + * + * @see http://schema.org/targetCollection + */ + public function targetCollection($targetCollection) + { + return $this->setProperty('targetCollection', $targetCollection); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AdministrativeArea.php b/src/AdministrativeArea.php index d9b9025b0..88dc840ce 100644 --- a/src/AdministrativeArea.php +++ b/src/AdministrativeArea.php @@ -2,14 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A geographical region, typically under the jurisdiction of a particular * government. * * @see http://schema.org/AdministrativeArea * - * @mixin \Spatie\SchemaOrg\Place */ -class AdministrativeArea extends BaseType +class AdministrativeArea extends BaseType implements PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AdultEntertainment.php b/src/AdultEntertainment.php index 06d54840e..a1ed67028 100644 --- a/src/AdultEntertainment.php +++ b/src/AdultEntertainment.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An adult entertainment establishment. * * @see http://schema.org/AdultEntertainment * - * @mixin \Spatie\SchemaOrg\EntertainmentBusiness */ -class AdultEntertainment extends BaseType +class AdultEntertainment extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AggregateOffer.php b/src/AggregateOffer.php index 1aae397ff..483165865 100644 --- a/src/AggregateOffer.php +++ b/src/AggregateOffer.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OfferContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * When a single product is associated with multiple offers (for example, the * same pair of shoes is offered by different merchants), then AggregateOffer @@ -9,9 +13,8 @@ * * @see http://schema.org/AggregateOffer * - * @mixin \Spatie\SchemaOrg\Offer */ -class AggregateOffer extends BaseType +class AggregateOffer extends BaseType implements OfferContract, IntangibleContract, ThingContract { /** * The highest price of all offers available. @@ -85,4 +88,835 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The payment method(s) accepted by seller for this offer. + * + * @param LoanOrCredit|LoanOrCredit[]|PaymentMethod|PaymentMethod[] $acceptedPaymentMethod + * + * @return static + * + * @see http://schema.org/acceptedPaymentMethod + */ + public function acceptedPaymentMethod($acceptedPaymentMethod) + { + return $this->setProperty('acceptedPaymentMethod', $acceptedPaymentMethod); + } + + /** + * An additional offer that can only be obtained in combination with the + * first base offer (e.g. supplements and extensions that are available for + * a surcharge). + * + * @param Offer|Offer[] $addOn + * + * @return static + * + * @see http://schema.org/addOn + */ + public function addOn($addOn) + { + return $this->setProperty('addOn', $addOn); + } + + /** + * The amount of time that is required between accepting the offer and the + * actual usage of the resource or service. + * + * @param QuantitativeValue|QuantitativeValue[] $advanceBookingRequirement + * + * @return static + * + * @see http://schema.org/advanceBookingRequirement + */ + public function advanceBookingRequirement($advanceBookingRequirement) + { + return $this->setProperty('advanceBookingRequirement', $advanceBookingRequirement); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * The availability of this item—for example In stock, Out of stock, + * Pre-order, etc. + * + * @param ItemAvailability|ItemAvailability[] $availability + * + * @return static + * + * @see http://schema.org/availability + */ + public function availability($availability) + { + return $this->setProperty('availability', $availability); + } + + /** + * The end of the availability of the product or service included in the + * offer. + * + * @param \DateTimeInterface|\DateTimeInterface[] $availabilityEnds + * + * @return static + * + * @see http://schema.org/availabilityEnds + */ + public function availabilityEnds($availabilityEnds) + { + return $this->setProperty('availabilityEnds', $availabilityEnds); + } + + /** + * The beginning of the availability of the product or service included in + * the offer. + * + * @param \DateTimeInterface|\DateTimeInterface[] $availabilityStarts + * + * @return static + * + * @see http://schema.org/availabilityStarts + */ + public function availabilityStarts($availabilityStarts) + { + return $this->setProperty('availabilityStarts', $availabilityStarts); + } + + /** + * The place(s) from which the offer can be obtained (e.g. store locations). + * + * @param Place|Place[] $availableAtOrFrom + * + * @return static + * + * @see http://schema.org/availableAtOrFrom + */ + public function availableAtOrFrom($availableAtOrFrom) + { + return $this->setProperty('availableAtOrFrom', $availableAtOrFrom); + } + + /** + * The delivery method(s) available for this offer. + * + * @param DeliveryMethod|DeliveryMethod[] $availableDeliveryMethod + * + * @return static + * + * @see http://schema.org/availableDeliveryMethod + */ + public function availableDeliveryMethod($availableDeliveryMethod) + { + return $this->setProperty('availableDeliveryMethod', $availableDeliveryMethod); + } + + /** + * The business function (e.g. sell, lease, repair, dispose) of the offer or + * component of a bundle (TypeAndQuantityNode). The default is + * http://purl.org/goodrelations/v1#Sell. + * + * @param BusinessFunction|BusinessFunction[] $businessFunction + * + * @return static + * + * @see http://schema.org/businessFunction + */ + public function businessFunction($businessFunction) + { + return $this->setProperty('businessFunction', $businessFunction); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * The typical delay between the receipt of the order and the goods either + * leaving the warehouse or being prepared for pickup, in case the delivery + * method is on site pickup. + * + * @param QuantitativeValue|QuantitativeValue[] $deliveryLeadTime + * + * @return static + * + * @see http://schema.org/deliveryLeadTime + */ + public function deliveryLeadTime($deliveryLeadTime) + { + return $this->setProperty('deliveryLeadTime', $deliveryLeadTime); + } + + /** + * The type(s) of customers for which the given offer is valid. + * + * @param BusinessEntityType|BusinessEntityType[] $eligibleCustomerType + * + * @return static + * + * @see http://schema.org/eligibleCustomerType + */ + public function eligibleCustomerType($eligibleCustomerType) + { + return $this->setProperty('eligibleCustomerType', $eligibleCustomerType); + } + + /** + * The duration for which the given offer is valid. + * + * @param QuantitativeValue|QuantitativeValue[] $eligibleDuration + * + * @return static + * + * @see http://schema.org/eligibleDuration + */ + public function eligibleDuration($eligibleDuration) + { + return $this->setProperty('eligibleDuration', $eligibleDuration); + } + + /** + * The interval and unit of measurement of ordering quantities for which the + * offer or price specification is valid. This allows e.g. specifying that a + * certain freight charge is valid only for a certain quantity. + * + * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity + * + * @return static + * + * @see http://schema.org/eligibleQuantity + */ + public function eligibleQuantity($eligibleQuantity) + { + return $this->setProperty('eligibleQuantity', $eligibleQuantity); + } + + /** + * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the + * GeoShape for the geo-political region(s) for which the offer or delivery + * charge specification is valid. + * + * See also [[ineligibleRegion]]. + * + * @param GeoShape|GeoShape[]|Place|Place[]|string|string[] $eligibleRegion + * + * @return static + * + * @see http://schema.org/eligibleRegion + */ + public function eligibleRegion($eligibleRegion) + { + return $this->setProperty('eligibleRegion', $eligibleRegion); + } + + /** + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. + * + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * + * @return static + * + * @see http://schema.org/eligibleTransactionVolume + */ + public function eligibleTransactionVolume($eligibleTransactionVolume) + { + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + } + + /** + * The GTIN-12 code of the product, or the product to which the offer + * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a + * U.P.C. Company Prefix, Item Reference, and Check Digit used to identify + * trade items. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin12 + * + * @return static + * + * @see http://schema.org/gtin12 + */ + public function gtin12($gtin12) + { + return $this->setProperty('gtin12', $gtin12); + } + + /** + * The GTIN-13 code of the product, or the product to which the offer + * refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former + * 12-digit UPC codes can be converted into a GTIN-13 code by simply adding + * a preceeding zero. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin13 + * + * @return static + * + * @see http://schema.org/gtin13 + */ + public function gtin13($gtin13) + { + return $this->setProperty('gtin13', $gtin13); + } + + /** + * The GTIN-14 code of the product, or the product to which the offer + * refers. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin14 + * + * @return static + * + * @see http://schema.org/gtin14 + */ + public function gtin14($gtin14) + { + return $this->setProperty('gtin14', $gtin14); + } + + /** + * The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of + * the product, or the product to which the offer refers. This code is also + * known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin8 + * + * @return static + * + * @see http://schema.org/gtin8 + */ + public function gtin8($gtin8) + { + return $this->setProperty('gtin8', $gtin8); + } + + /** + * This links to a node or nodes indicating the exact quantity of the + * products included in the offer. + * + * @param TypeAndQuantityNode|TypeAndQuantityNode[] $includesObject + * + * @return static + * + * @see http://schema.org/includesObject + */ + public function includesObject($includesObject) + { + return $this->setProperty('includesObject', $includesObject); + } + + /** + * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the + * GeoShape for the geo-political region(s) for which the offer or delivery + * charge specification is not valid, e.g. a region where the transaction is + * not allowed. + * + * See also [[eligibleRegion]]. + * + * @param GeoShape|GeoShape[]|Place|Place[]|string|string[] $ineligibleRegion + * + * @return static + * + * @see http://schema.org/ineligibleRegion + */ + public function ineligibleRegion($ineligibleRegion) + { + return $this->setProperty('ineligibleRegion', $ineligibleRegion); + } + + /** + * The current approximate inventory level for the item or items. + * + * @param QuantitativeValue|QuantitativeValue[] $inventoryLevel + * + * @return static + * + * @see http://schema.org/inventoryLevel + */ + public function inventoryLevel($inventoryLevel) + { + return $this->setProperty('inventoryLevel', $inventoryLevel); + } + + /** + * A predefined value from OfferItemCondition or a textual description of + * the condition of the product or service, or the products or services + * included in the offer. + * + * @param OfferItemCondition|OfferItemCondition[] $itemCondition + * + * @return static + * + * @see http://schema.org/itemCondition + */ + public function itemCondition($itemCondition) + { + return $this->setProperty('itemCondition', $itemCondition); + } + + /** + * The item being offered. + * + * @param Product|Product[]|Service|Service[] $itemOffered + * + * @return static + * + * @see http://schema.org/itemOffered + */ + public function itemOffered($itemOffered) + { + return $this->setProperty('itemOffered', $itemOffered); + } + + /** + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. + * + * @param string|string[] $mpn + * + * @return static + * + * @see http://schema.org/mpn + */ + public function mpn($mpn) + { + return $this->setProperty('mpn', $mpn); + } + + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * The date after which the price is no longer available. + * + * @param \DateTimeInterface|\DateTimeInterface[] $priceValidUntil + * + * @return static + * + * @see http://schema.org/priceValidUntil + */ + public function priceValidUntil($priceValidUntil) + { + return $this->setProperty('priceValidUntil', $priceValidUntil); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * An entity which offers (sells / leases / lends / loans) the services / + * goods. A seller may also be a provider. + * + * @param Organization|Organization[]|Person|Person[] $seller + * + * @return static + * + * @see http://schema.org/seller + */ + public function seller($seller) + { + return $this->setProperty('seller', $seller); + } + + /** + * The serial number or any alphanumeric identifier of a particular product. + * When attached to an offer, it is a shortcut for the serial number of the + * product included in the offer. + * + * @param string|string[] $serialNumber + * + * @return static + * + * @see http://schema.org/serialNumber + */ + public function serialNumber($serialNumber) + { + return $this->setProperty('serialNumber', $serialNumber); + } + + /** + * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a + * product or service, or the product to which the offer refers. + * + * @param string|string[] $sku + * + * @return static + * + * @see http://schema.org/sku + */ + public function sku($sku) + { + return $this->setProperty('sku', $sku); + } + + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * + * @return static + * + * @see http://schema.org/validThrough + */ + public function validThrough($validThrough) + { + return $this->setProperty('validThrough', $validThrough); + } + + /** + * The warranty promise(s) included in the offer. + * + * @param WarrantyPromise|WarrantyPromise[] $warranty + * + * @return static + * + * @see http://schema.org/warranty + */ + public function warranty($warranty) + { + return $this->setProperty('warranty', $warranty); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AggregateRating.php b/src/AggregateRating.php index 060dca53d..a38538a57 100644 --- a/src/AggregateRating.php +++ b/src/AggregateRating.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\RatingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The average rating based on multiple ratings or reviews. * * @see http://schema.org/AggregateRating * - * @mixin \Spatie\SchemaOrg\Rating */ -class AggregateRating extends BaseType +class AggregateRating extends BaseType implements RatingContract, IntangibleContract, ThingContract { /** * The item that is being reviewed/rated. @@ -53,4 +56,272 @@ public function reviewCount($reviewCount) return $this->setProperty('reviewCount', $reviewCount); } + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * The highest value allowed in this rating system. If bestRating is + * omitted, 5 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $bestRating + * + * @return static + * + * @see http://schema.org/bestRating + */ + public function bestRating($bestRating) + { + return $this->setProperty('bestRating', $bestRating); + } + + /** + * The rating for the content. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $ratingValue + * + * @return static + * + * @see http://schema.org/ratingValue + */ + public function ratingValue($ratingValue) + { + return $this->setProperty('ratingValue', $ratingValue); + } + + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + + /** + * The lowest value allowed in this rating system. If worstRating is + * omitted, 1 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $worstRating + * + * @return static + * + * @see http://schema.org/worstRating + */ + public function worstRating($worstRating) + { + return $this->setProperty('worstRating', $worstRating); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AgreeAction.php b/src/AgreeAction.php index bd65586bb..1aebc9e28 100644 --- a/src/AgreeAction.php +++ b/src/AgreeAction.php @@ -2,14 +2,383 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of expressing a consistency of opinion with the object. An agent * agrees to/about an object (a proposition, topic or theme) with participants. * * @see http://schema.org/AgreeAction * - * @mixin \Spatie\SchemaOrg\ReactAction */ -class AgreeAction extends BaseType +class AgreeAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Airline.php b/src/Airline.php index 03b890a08..5b9ee1f27 100644 --- a/src/Airline.php +++ b/src/Airline.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An organization that provides flights for passengers. * * @see http://schema.org/Airline * - * @mixin \Spatie\SchemaOrg\Organization */ -class Airline extends BaseType +class Airline extends BaseType implements OrganizationContract, ThingContract { /** * The type of boarding policy used by the airline (e.g. zone-based or @@ -40,4 +42,926 @@ public function iataCode($iataCode) return $this->setProperty('iataCode', $iataCode); } + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Airport.php b/src/Airport.php index 51104773e..7456875b0 100644 --- a/src/Airport.php +++ b/src/Airport.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An airport. * * @see http://schema.org/Airport * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Airport extends BaseType +class Airport extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { /** * IATA identifier for an airline or airport. @@ -39,4 +42,699 @@ public function icaoCode($icaoCode) return $this->setProperty('icaoCode', $icaoCode); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AlignmentObject.php b/src/AlignmentObject.php index a23a3cbd6..ecbc906d3 100644 --- a/src/AlignmentObject.php +++ b/src/AlignmentObject.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An intangible item that describes an alignment between a learning resource * and a node in an educational framework. * * @see http://schema.org/AlignmentObject * - * @mixin \Spatie\SchemaOrg\Intangible */ -class AlignmentObject extends BaseType +class AlignmentObject extends BaseType implements IntangibleContract, ThingContract { /** * A category of alignment between the learning resource and the framework @@ -85,4 +87,190 @@ public function targetUrl($targetUrl) return $this->setProperty('targetUrl', $targetUrl); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AllocateAction.php b/src/AllocateAction.php index 3ed4ab2cd..6a96ba762 100644 --- a/src/AllocateAction.php +++ b/src/AllocateAction.php @@ -2,13 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of organizing tasks/objects/events by associating resources to it. * * @see http://schema.org/AllocateAction * - * @mixin \Spatie\SchemaOrg\OrganizeAction */ -class AllocateAction extends BaseType +class AllocateAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AmusementPark.php b/src/AmusementPark.php index 2a29c6f44..2e9b5434e 100644 --- a/src/AmusementPark.php +++ b/src/AmusementPark.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An amusement park. * * @see http://schema.org/AmusementPark * - * @mixin \Spatie\SchemaOrg\EntertainmentBusiness */ -class AmusementPark extends BaseType +class AmusementPark extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AnimalShelter.php b/src/AnimalShelter.php index 31a6bc761..414cff9c9 100644 --- a/src/AnimalShelter.php +++ b/src/AnimalShelter.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Animal shelter. * * @see http://schema.org/AnimalShelter * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class AnimalShelter extends BaseType +class AnimalShelter extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Answer.php b/src/Answer.php index 768fd79db..00bcf38c3 100644 --- a/src/Answer.php +++ b/src/Answer.php @@ -2,14 +2,1566 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommentContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An answer offered to a question; perhaps correct, perhaps opinionated or * wrong. * * @see http://schema.org/Answer * - * @mixin \Spatie\SchemaOrg\Comment */ -class Answer extends BaseType +class Answer extends BaseType implements CommentContract, CreativeWorkContract, ThingContract { + /** + * The number of downvotes this question, answer or comment has received + * from the community. + * + * @param int|int[] $downvoteCount + * + * @return static + * + * @see http://schema.org/downvoteCount + */ + public function downvoteCount($downvoteCount) + { + return $this->setProperty('downvoteCount', $downvoteCount); + } + + /** + * The parent of a question, answer or item in general. + * + * @param Question|Question[] $parentItem + * + * @return static + * + * @see http://schema.org/parentItem + */ + public function parentItem($parentItem) + { + return $this->setProperty('parentItem', $parentItem); + } + + /** + * The number of upvotes this question, answer or comment has received from + * the community. + * + * @param int|int[] $upvoteCount + * + * @return static + * + * @see http://schema.org/upvoteCount + */ + public function upvoteCount($upvoteCount) + { + return $this->setProperty('upvoteCount', $upvoteCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Apartment.php b/src/Apartment.php index 1298eb183..62c0e0d64 100644 --- a/src/Apartment.php +++ b/src/Apartment.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An apartment (in American English) or flat (in British English) is a * self-contained housing unit (a type of residential real estate) that occupies @@ -10,9 +14,8 @@ * * @see http://schema.org/Apartment * - * @mixin \Spatie\SchemaOrg\Accommodation */ -class Apartment extends BaseType +class Apartment extends BaseType implements AccommodationContract, PlaceContract, ThingContract { /** * The number of rooms (excluding bathrooms and closets) of the @@ -49,4 +52,732 @@ public function occupancy($occupancy) return $this->setProperty('occupancy', $occupancy); } + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indications regarding the permitted usage of the accommodation. + * + * @param string|string[] $permittedUsage + * + * @return static + * + * @see http://schema.org/permittedUsage + */ + public function permittedUsage($permittedUsage) + { + return $this->setProperty('permittedUsage', $permittedUsage); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ApartmentComplex.php b/src/ApartmentComplex.php index 46640a14a..8d5605a21 100644 --- a/src/ApartmentComplex.php +++ b/src/ApartmentComplex.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ResidenceContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Residence type: Apartment complex. * * @see http://schema.org/ApartmentComplex * - * @mixin \Spatie\SchemaOrg\Residence */ -class ApartmentComplex extends BaseType +class ApartmentComplex extends BaseType implements ResidenceContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AppendAction.php b/src/AppendAction.php index 881109d5d..c7847e125 100644 --- a/src/AppendAction.php +++ b/src/AppendAction.php @@ -2,13 +2,426 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InsertActionContract; +use \Spatie\SchemaOrg\Contracts\AddActionContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of inserting at the end if an ordered collection. * * @see http://schema.org/AppendAction * - * @mixin \Spatie\SchemaOrg\InsertAction */ -class AppendAction extends BaseType +class AppendAction extends BaseType implements InsertActionContract, AddActionContract, UpdateActionContract, ActionContract, ThingContract { + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $collection + * + * @return static + * + * @see http://schema.org/collection + */ + public function collection($collection) + { + return $this->setProperty('collection', $collection); + } + + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $targetCollection + * + * @return static + * + * @see http://schema.org/targetCollection + */ + public function targetCollection($targetCollection) + { + return $this->setProperty('targetCollection', $targetCollection); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ApplyAction.php b/src/ApplyAction.php index 671adb921..c25298085 100644 --- a/src/ApplyAction.php +++ b/src/ApplyAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of registering to an organization/service without the guarantee to * receive it. @@ -13,8 +17,372 @@ * * @see http://schema.org/ApplyAction * - * @mixin \Spatie\SchemaOrg\OrganizeAction */ -class ApplyAction extends BaseType +class ApplyAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Aquarium.php b/src/Aquarium.php index 6d242a352..a05c88b56 100644 --- a/src/Aquarium.php +++ b/src/Aquarium.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Aquarium. * * @see http://schema.org/Aquarium * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Aquarium extends BaseType +class Aquarium extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ArriveAction.php b/src/ArriveAction.php index 75713914a..e2fa07c03 100644 --- a/src/ArriveAction.php +++ b/src/ArriveAction.php @@ -2,14 +2,412 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MoveActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of arriving at a place. An agent arrives at a destination from a * fromLocation, optionally with participants. * * @see http://schema.org/ArriveAction * - * @mixin \Spatie\SchemaOrg\MoveAction */ -class ArriveAction extends BaseType +class ArriveAction extends BaseType implements MoveActionContract, ActionContract, ThingContract { + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ArtGallery.php b/src/ArtGallery.php index 75cf99268..f6596eb32 100644 --- a/src/ArtGallery.php +++ b/src/ArtGallery.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An art gallery. * * @see http://schema.org/ArtGallery * - * @mixin \Spatie\SchemaOrg\EntertainmentBusiness */ -class ArtGallery extends BaseType +class ArtGallery extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Article.php b/src/Article.php index 6e8d50453..abd51c991 100644 --- a/src/Article.php +++ b/src/Article.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An article, such as a news article or piece of investigative report. * Newspapers and magazines have articles of many different types and this is @@ -12,9 +15,8 @@ * * @see http://schema.org/Article * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Article extends BaseType +class Article extends BaseType implements CreativeWorkContract, ThingContract { /** * The actual body of the article. @@ -141,4 +143,1509 @@ public function wordCount($wordCount) return $this->setProperty('wordCount', $wordCount); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AskAction.php b/src/AskAction.php index c4de4460d..bb0a2b74b 100644 --- a/src/AskAction.php +++ b/src/AskAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of posing a question / favor to someone. * @@ -11,9 +16,8 @@ * * @see http://schema.org/AskAction * - * @mixin \Spatie\SchemaOrg\CommunicateAction */ -class AskAction extends BaseType +class AskAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** * A sub property of object. A question. @@ -29,4 +33,429 @@ public function question($question) return $this->setProperty('question', $question); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AssessAction.php b/src/AssessAction.php index a67f3c214..ce80665eb 100644 --- a/src/AssessAction.php +++ b/src/AssessAction.php @@ -2,13 +2,380 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of forming one's opinion, reaction or sentiment. * * @see http://schema.org/AssessAction * - * @mixin \Spatie\SchemaOrg\Action */ -class AssessAction extends BaseType +class AssessAction extends BaseType implements ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AssignAction.php b/src/AssignAction.php index 4086377e7..bdc4f6f48 100644 --- a/src/AssignAction.php +++ b/src/AssignAction.php @@ -2,14 +2,383 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AllocateActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of allocating an action/event/task to some destination (someone or * something). * * @see http://schema.org/AssignAction * - * @mixin \Spatie\SchemaOrg\AllocateAction */ -class AssignAction extends BaseType +class AssignAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Attorney.php b/src/Attorney.php index 9b51cc168..e99ef0db3 100644 --- a/src/Attorney.php +++ b/src/Attorney.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LegalServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Professional service: Attorney. * @@ -10,8 +16,1328 @@ * * @see http://schema.org/Attorney * - * @mixin \Spatie\SchemaOrg\LegalService */ -class Attorney extends BaseType +class Attorney extends BaseType implements LegalServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Audience.php b/src/Audience.php index 578a2aa5c..ff4b0f0c6 100644 --- a/src/Audience.php +++ b/src/Audience.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Intended audience for an item, i.e. the group for whom the item was created. * * @see http://schema.org/Audience * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Audience extends BaseType +class Audience extends BaseType implements IntangibleContract, ThingContract { /** * Researchers. @@ -47,4 +49,190 @@ public function geographicArea($geographicArea) return $this->setProperty('geographicArea', $geographicArea); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AudioObject.php b/src/AudioObject.php index 22bd7e986..eddbbc4d3 100644 --- a/src/AudioObject.php +++ b/src/AudioObject.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An audio file. * * @see http://schema.org/AudioObject * - * @mixin \Spatie\SchemaOrg\MediaObject */ -class AudioObject extends BaseType +class AudioObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { /** * The caption for this object. For downloadable machine formats (closed @@ -42,4 +45,1760 @@ public function transcript($transcript) return $this->setProperty('transcript', $transcript); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Date when this media object was uploaded to this site. + * + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate + * + * @return static + * + * @see http://schema.org/uploadDate + */ + public function uploadDate($uploadDate) + { + return $this->setProperty('uploadDate', $uploadDate); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AuthorizeAction.php b/src/AuthorizeAction.php index 27c4def69..5f4f08a3e 100644 --- a/src/AuthorizeAction.php +++ b/src/AuthorizeAction.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AllocateActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of granting permission to an object. * * @see http://schema.org/AuthorizeAction * - * @mixin \Spatie\SchemaOrg\AllocateAction */ -class AuthorizeAction extends BaseType +class AuthorizeAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract { /** * A sub property of participant. The participant who is at the receiving @@ -26,4 +30,369 @@ public function recipient($recipient) return $this->setProperty('recipient', $recipient); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/AutoBodyShop.php b/src/AutoBodyShop.php index e277e1b8c..f5f63ac84 100644 --- a/src/AutoBodyShop.php +++ b/src/AutoBodyShop.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Auto body shop. * * @see http://schema.org/AutoBodyShop * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness */ -class AutoBodyShop extends BaseType +class AutoBodyShop extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AutoDealer.php b/src/AutoDealer.php index cc20b4eaa..b7f70bd3e 100644 --- a/src/AutoDealer.php +++ b/src/AutoDealer.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An car dealership. * * @see http://schema.org/AutoDealer * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness */ -class AutoDealer extends BaseType +class AutoDealer extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AutoPartsStore.php b/src/AutoPartsStore.php index 5e20d3710..9f5fb05f9 100644 --- a/src/AutoPartsStore.php +++ b/src/AutoPartsStore.php @@ -2,14 +2,1340 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An auto parts store. * * @see http://schema.org/AutoPartsStore * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness - * @mixin \Spatie\SchemaOrg\Store */ -class AutoPartsStore extends BaseType +class AutoPartsStore extends BaseType implements AutomotiveBusinessContract, StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AutoRental.php b/src/AutoRental.php index 6ef287ce3..6cc3450ac 100644 --- a/src/AutoRental.php +++ b/src/AutoRental.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A car rental business. * * @see http://schema.org/AutoRental * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness */ -class AutoRental extends BaseType +class AutoRental extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AutoRepair.php b/src/AutoRepair.php index 53be04a5c..50d16b64e 100644 --- a/src/AutoRepair.php +++ b/src/AutoRepair.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Car repair business. * * @see http://schema.org/AutoRepair * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness */ -class AutoRepair extends BaseType +class AutoRepair extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AutoWash.php b/src/AutoWash.php index d18ebed13..ec33df8bf 100644 --- a/src/AutoWash.php +++ b/src/AutoWash.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A car wash business. * * @see http://schema.org/AutoWash * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness */ -class AutoWash extends BaseType +class AutoWash extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AutomatedTeller.php b/src/AutomatedTeller.php index 1b34a130e..5426eaf52 100644 --- a/src/AutomatedTeller.php +++ b/src/AutomatedTeller.php @@ -2,13 +2,1354 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * ATM/cash machine. * * @see http://schema.org/AutomatedTeller * - * @mixin \Spatie\SchemaOrg\FinancialService */ -class AutomatedTeller extends BaseType +class AutomatedTeller extends BaseType implements FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/AutomotiveBusiness.php b/src/AutomotiveBusiness.php index 5677d1209..493400eff 100644 --- a/src/AutomotiveBusiness.php +++ b/src/AutomotiveBusiness.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Car repair, sales, or parts. * * @see http://schema.org/AutomotiveBusiness * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class AutomotiveBusiness extends BaseType +class AutomotiveBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Bakery.php b/src/Bakery.php index 943ecadea..2e0bfa50c 100644 --- a/src/Bakery.php +++ b/src/Bakery.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A bakery. * * @see http://schema.org/Bakery * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class Bakery extends BaseType +class Bakery extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/BankAccount.php b/src/BankAccount.php index 631169403..8e6a24de4 100644 --- a/src/BankAccount.php +++ b/src/BankAccount.php @@ -2,14 +2,589 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A product or service offered by a bank whereby one may deposit, withdraw or * transfer money and in some cases be paid interest. * * @see http://schema.org/BankAccount * - * @mixin \Spatie\SchemaOrg\FinancialProduct */ -class BankAccount extends BaseType +class BankAccount extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * + * @return static + * + * @see http://schema.org/interestRate + */ + public function interestRate($interestRate) + { + return $this->setProperty('interestRate', $interestRate); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BankOrCreditUnion.php b/src/BankOrCreditUnion.php index b9d6feeae..b1e6be8fd 100644 --- a/src/BankOrCreditUnion.php +++ b/src/BankOrCreditUnion.php @@ -2,13 +2,1354 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Bank or credit union. * * @see http://schema.org/BankOrCreditUnion * - * @mixin \Spatie\SchemaOrg\FinancialService */ -class BankOrCreditUnion extends BaseType +class BankOrCreditUnion extends BaseType implements FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/BarOrPub.php b/src/BarOrPub.php index fabf99cf1..b69ea1bbf 100644 --- a/src/BarOrPub.php +++ b/src/BarOrPub.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A bar or pub. * * @see http://schema.org/BarOrPub * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class BarOrPub extends BaseType +class BarOrPub extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Barcode.php b/src/Barcode.php index 5dee754af..e79e0d08e 100644 --- a/src/Barcode.php +++ b/src/Barcode.php @@ -2,13 +2,1832 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ImageObjectContract; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An image of a visual machine-readable code such as a barcode or QR code. * * @see http://schema.org/Barcode * - * @mixin \Spatie\SchemaOrg\ImageObject */ -class Barcode extends BaseType +class Barcode extends BaseType implements ImageObjectContract, MediaObjectContract, CreativeWorkContract, ThingContract { + /** + * The caption for this object. For downloadable machine formats (closed + * caption, subtitles etc.) use MediaObject and indicate the + * [[encodingFormat]]. + * + * @param MediaObject|MediaObject[]|string|string[] $caption + * + * @return static + * + * @see http://schema.org/caption + */ + public function caption($caption) + { + return $this->setProperty('caption', $caption); + } + + /** + * exif data for this object. + * + * @param PropertyValue|PropertyValue[]|string|string[] $exifData + * + * @return static + * + * @see http://schema.org/exifData + */ + public function exifData($exifData) + { + return $this->setProperty('exifData', $exifData); + } + + /** + * Indicates whether this image is representative of the content of the + * page. + * + * @param bool|bool[] $representativeOfPage + * + * @return static + * + * @see http://schema.org/representativeOfPage + */ + public function representativeOfPage($representativeOfPage) + { + return $this->setProperty('representativeOfPage', $representativeOfPage); + } + + /** + * Thumbnail image for an image or video. + * + * @param ImageObject|ImageObject[] $thumbnail + * + * @return static + * + * @see http://schema.org/thumbnail + */ + public function thumbnail($thumbnail) + { + return $this->setProperty('thumbnail', $thumbnail); + } + + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Date when this media object was uploaded to this site. + * + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate + * + * @return static + * + * @see http://schema.org/uploadDate + */ + public function uploadDate($uploadDate) + { + return $this->setProperty('uploadDate', $uploadDate); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Beach.php b/src/Beach.php index 91575bed4..ba7d9a5ce 100644 --- a/src/Beach.php +++ b/src/Beach.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Beach. * * @see http://schema.org/Beach * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Beach extends BaseType +class Beach extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BeautySalon.php b/src/BeautySalon.php index 0603c55fe..5bfd94d17 100644 --- a/src/BeautySalon.php +++ b/src/BeautySalon.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HealthAndBeautyBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Beauty salon. * * @see http://schema.org/BeautySalon * - * @mixin \Spatie\SchemaOrg\HealthAndBeautyBusiness */ -class BeautySalon extends BaseType +class BeautySalon extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/BedAndBreakfast.php b/src/BedAndBreakfast.php index cef3a9793..6b42a3150 100644 --- a/src/BedAndBreakfast.php +++ b/src/BedAndBreakfast.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Bed and breakfast. * @@ -10,8 +16,1435 @@ * * @see http://schema.org/BedAndBreakfast * - * @mixin \Spatie\SchemaOrg\LodgingBusiness */ -class BedAndBreakfast extends BaseType +class BedAndBreakfast extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * + * @param Language|Language[]|string|string[] $availableLanguage + * + * @return static + * + * @see http://schema.org/availableLanguage + */ + public function availableLanguage($availableLanguage) + { + return $this->setProperty('availableLanguage', $availableLanguage); + } + + /** + * The earliest someone may check into a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * + * @return static + * + * @see http://schema.org/checkinTime + */ + public function checkinTime($checkinTime) + { + return $this->setProperty('checkinTime', $checkinTime); + } + + /** + * The latest someone may check out of a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * + * @return static + * + * @see http://schema.org/checkoutTime + */ + public function checkoutTime($checkoutTime) + { + return $this->setProperty('checkoutTime', $checkoutTime); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/BedDetails.php b/src/BedDetails.php index 2e9e0993a..f9beb1746 100644 --- a/src/BedDetails.php +++ b/src/BedDetails.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An entity holding detailed information about the available bed types, e.g. * the quantity of twin beds for a hotel room. For the single case of just one @@ -10,9 +13,8 @@ * * @see http://schema.org/BedDetails * - * @mixin \Spatie\SchemaOrg\Intangible */ -class BedDetails extends BaseType +class BedDetails extends BaseType implements IntangibleContract, ThingContract { /** * The quantity of the given bed type available in the HotelRoom, Suite, @@ -44,4 +46,190 @@ public function typeOfBed($typeOfBed) return $this->setProperty('typeOfBed', $typeOfBed); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BedType.php b/src/BedType.php index 2f535ed16..2d91631fa 100644 --- a/src/BedType.php +++ b/src/BedType.php @@ -2,14 +2,331 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A type of bed. This is used for indicating the bed or beds available in an * accommodation. * * @see http://schema.org/BedType * - * @mixin \Spatie\SchemaOrg\QualitativeValue */ -class BedType extends BaseType +class BedType extends BaseType implements QualitativeValueContract, EnumerationContract, IntangibleContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $equal + * + * @return static + * + * @see http://schema.org/equal + */ + public function equal($equal) + { + return $this->setProperty('equal', $equal); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is greater than the object. + * + * @param QualitativeValue|QualitativeValue[] $greater + * + * @return static + * + * @see http://schema.org/greater + */ + public function greater($greater) + { + return $this->setProperty('greater', $greater); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is greater than or equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $greaterOrEqual + * + * @return static + * + * @see http://schema.org/greaterOrEqual + */ + public function greaterOrEqual($greaterOrEqual) + { + return $this->setProperty('greaterOrEqual', $greaterOrEqual); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is lesser than the object. + * + * @param QualitativeValue|QualitativeValue[] $lesser + * + * @return static + * + * @see http://schema.org/lesser + */ + public function lesser($lesser) + { + return $this->setProperty('lesser', $lesser); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is lesser than or equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $lesserOrEqual + * + * @return static + * + * @see http://schema.org/lesserOrEqual + */ + public function lesserOrEqual($lesserOrEqual) + { + return $this->setProperty('lesserOrEqual', $lesserOrEqual); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is not equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $nonEqual + * + * @return static + * + * @see http://schema.org/nonEqual + */ + public function nonEqual($nonEqual) + { + return $this->setProperty('nonEqual', $nonEqual); + } + + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BefriendAction.php b/src/BefriendAction.php index 8252b277f..4f218a823 100644 --- a/src/BefriendAction.php +++ b/src/BefriendAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of forming a personal connection with someone (object) * mutually/bidirectionally/symmetrically. @@ -13,8 +17,372 @@ * * @see http://schema.org/BefriendAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class BefriendAction extends BaseType +class BefriendAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BikeStore.php b/src/BikeStore.php index ad29cc6e1..ac3c020b6 100644 --- a/src/BikeStore.php +++ b/src/BikeStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A bike store. * * @see http://schema.org/BikeStore * - * @mixin \Spatie\SchemaOrg\Store */ -class BikeStore extends BaseType +class BikeStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Blog.php b/src/Blog.php index 1c974115b..91b77824b 100644 --- a/src/Blog.php +++ b/src/Blog.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A blog. * * @see http://schema.org/Blog * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Blog extends BaseType +class Blog extends BaseType implements CreativeWorkContract, ThingContract { /** * A posting that is part of this blog. @@ -55,4 +57,1509 @@ public function issn($issn) return $this->setProperty('issn', $issn); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BlogPosting.php b/src/BlogPosting.php index 077fbac82..fe48135b1 100644 --- a/src/BlogPosting.php +++ b/src/BlogPosting.php @@ -2,13 +2,1662 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A blog post. * * @see http://schema.org/BlogPosting * - * @mixin \Spatie\SchemaOrg\SocialMediaPosting */ -class BlogPosting extends BaseType +class BlogPosting extends BaseType implements SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract { + /** + * A CreativeWork such as an image, video, or audio clip shared as part of + * this posting. + * + * @param CreativeWork|CreativeWork[] $sharedContent + * + * @return static + * + * @see http://schema.org/sharedContent + */ + public function sharedContent($sharedContent) + { + return $this->setProperty('sharedContent', $sharedContent); + } + + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BoardingPolicyType.php b/src/BoardingPolicyType.php index 6f25177f9..92a8a8e76 100644 --- a/src/BoardingPolicyType.php +++ b/src/BoardingPolicyType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A type of boarding policy used by an airline. * * @see http://schema.org/BoardingPolicyType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class BoardingPolicyType extends BaseType +class BoardingPolicyType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * The airline boards by groups based on check-in time, priority, etc. @@ -25,4 +28,190 @@ class BoardingPolicyType extends BaseType */ const ZoneBoardingPolicy = 'http://schema.org/ZoneBoardingPolicy'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BodyOfWater.php b/src/BodyOfWater.php index a201fdc47..86d415a09 100644 --- a/src/BodyOfWater.php +++ b/src/BodyOfWater.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A body of water, such as a sea, ocean, or lake. * * @see http://schema.org/BodyOfWater * - * @mixin \Spatie\SchemaOrg\Landform */ -class BodyOfWater extends BaseType +class BodyOfWater extends BaseType implements LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Book.php b/src/Book.php index acea98f8b..63b22aa87 100644 --- a/src/Book.php +++ b/src/Book.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A book. * * @see http://schema.org/Book * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Book extends BaseType +class Book extends BaseType implements CreativeWorkContract, ThingContract { /** * The edition of the book. @@ -81,4 +83,1509 @@ public function numberOfPages($numberOfPages) return $this->setProperty('numberOfPages', $numberOfPages); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BookFormatType.php b/src/BookFormatType.php index c4856836b..2fc4cfa71 100644 --- a/src/BookFormatType.php +++ b/src/BookFormatType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The publication format of the book. * * @see http://schema.org/BookFormatType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class BookFormatType extends BaseType +class BookFormatType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * Book format: Audiobook. This is an enumerated value for use with the @@ -41,4 +44,190 @@ class BookFormatType extends BaseType */ const Paperback = 'http://schema.org/Paperback'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BookSeries.php b/src/BookSeries.php index ca9a7bda0..bc18937e3 100644 --- a/src/BookSeries.php +++ b/src/BookSeries.php @@ -2,13 +2,1585 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A series of books. Included books can be indicated with the hasPart property. * * @see http://schema.org/BookSeries * - * @mixin \Spatie\SchemaOrg\CreativeWorkSeries */ -class BookSeries extends BaseType +class BookSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + } diff --git a/src/BookStore.php b/src/BookStore.php index ff2467960..a116027c2 100644 --- a/src/BookStore.php +++ b/src/BookStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A bookstore. * * @see http://schema.org/BookStore * - * @mixin \Spatie\SchemaOrg\Store */ -class BookStore extends BaseType +class BookStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/BookmarkAction.php b/src/BookmarkAction.php index 5df2cae8f..e1e06b3df 100644 --- a/src/BookmarkAction.php +++ b/src/BookmarkAction.php @@ -2,13 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent bookmarks/flags/labels/tags/marks an object. * * @see http://schema.org/BookmarkAction * - * @mixin \Spatie\SchemaOrg\OrganizeAction */ -class BookmarkAction extends BaseType +class BookmarkAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BorrowAction.php b/src/BorrowAction.php index 6ffaf3193..af76d39e1 100644 --- a/src/BorrowAction.php +++ b/src/BorrowAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of obtaining an object under an agreement to return it at a later * date. Reciprocal of LendAction. @@ -12,9 +16,8 @@ * * @see http://schema.org/BorrowAction * - * @mixin \Spatie\SchemaOrg\TransferAction */ -class BorrowAction extends BaseType +class BorrowAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** * A sub property of participant. The person that lends the object being @@ -31,4 +34,399 @@ public function lender($lender) return $this->setProperty('lender', $lender); } + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BowlingAlley.php b/src/BowlingAlley.php index 88e8ae8aa..4ab414858 100644 --- a/src/BowlingAlley.php +++ b/src/BowlingAlley.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A bowling alley. * * @see http://schema.org/BowlingAlley * - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class BowlingAlley extends BaseType +class BowlingAlley extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Brand.php b/src/Brand.php index 505da5722..48c53f150 100644 --- a/src/Brand.php +++ b/src/Brand.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A brand is a name used by an organization or business person for labeling a * product, product group, or similar. * * @see http://schema.org/Brand * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Brand extends BaseType +class Brand extends BaseType implements IntangibleContract, ThingContract { /** * The overall rating, based on a collection of reviews or ratings, of the @@ -69,4 +71,190 @@ public function slogan($slogan) return $this->setProperty('slogan', $slogan); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BreadcrumbList.php b/src/BreadcrumbList.php index 7810d8ed5..11d0e75c8 100644 --- a/src/BreadcrumbList.php +++ b/src/BreadcrumbList.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ItemListContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A BreadcrumbList is an ItemList consisting of a chain of linked Web pages, * typically described using at least their URL and their name, and typically @@ -17,8 +21,248 @@ * * @see http://schema.org/BreadcrumbList * - * @mixin \Spatie\SchemaOrg\ItemList */ -class BreadcrumbList extends BaseType +class BreadcrumbList extends BaseType implements ItemListContract, IntangibleContract, ThingContract { + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Brewery.php b/src/Brewery.php index 51832baee..af348ff02 100644 --- a/src/Brewery.php +++ b/src/Brewery.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Brewery. * * @see http://schema.org/Brewery * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class Brewery extends BaseType +class Brewery extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Bridge.php b/src/Bridge.php index 1ecf96779..71dc55efc 100644 --- a/src/Bridge.php +++ b/src/Bridge.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A bridge. * * @see http://schema.org/Bridge * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Bridge extends BaseType +class Bridge extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BroadcastChannel.php b/src/BroadcastChannel.php index faa8d92f4..f94a8b079 100644 --- a/src/BroadcastChannel.php +++ b/src/BroadcastChannel.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A unique instance of a BroadcastService on a CableOrSatelliteService lineup. * * @see http://schema.org/BroadcastChannel * - * @mixin \Spatie\SchemaOrg\Intangible */ -class BroadcastChannel extends BaseType +class BroadcastChannel extends BaseType implements IntangibleContract, ThingContract { /** * The unique address by which the BroadcastService can be identified in a @@ -99,4 +101,190 @@ public function providesBroadcastService($providesBroadcastService) return $this->setProperty('providesBroadcastService', $providesBroadcastService); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BroadcastEvent.php b/src/BroadcastEvent.php index b6a1001c6..236cd2716 100644 --- a/src/BroadcastEvent.php +++ b/src/BroadcastEvent.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PublicationEventContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An over the air or online broadcast event. * * @see http://schema.org/BroadcastEvent * - * @mixin \Spatie\SchemaOrg\PublicationEvent */ -class BroadcastEvent extends BaseType +class BroadcastEvent extends BaseType implements PublicationEventContract, EventContract, ThingContract { /** * The event being broadcast such as a sporting event or awards ceremony. @@ -54,4 +57,743 @@ public function videoFormat($videoFormat) return $this->setProperty('videoFormat', $videoFormat); } + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $free + * + * @return static + * + * @see http://schema.org/free + */ + public function free($free) + { + return $this->setProperty('free', $free); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A broadcast service associated with the publication event. + * + * @param BroadcastService|BroadcastService[] $publishedOn + * + * @return static + * + * @see http://schema.org/publishedOn + */ + public function publishedOn($publishedOn) + { + return $this->setProperty('publishedOn', $publishedOn); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BroadcastFrequencySpecification.php b/src/BroadcastFrequencySpecification.php index ce9c02e80..8e0a3fe44 100644 --- a/src/BroadcastFrequencySpecification.php +++ b/src/BroadcastFrequencySpecification.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The frequency in MHz and the modulation used for a particular * BroadcastService. * * @see http://schema.org/BroadcastFrequencySpecification * - * @mixin \Spatie\SchemaOrg\Intangible */ -class BroadcastFrequencySpecification extends BaseType +class BroadcastFrequencySpecification extends BaseType implements IntangibleContract, ThingContract { /** * The frequency in MHz for a particular broadcast. @@ -26,4 +28,190 @@ public function broadcastFrequencyValue($broadcastFrequencyValue) return $this->setProperty('broadcastFrequencyValue', $broadcastFrequencyValue); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BroadcastService.php b/src/BroadcastService.php index 9cbf896f1..4af34e2bb 100644 --- a/src/BroadcastService.php +++ b/src/BroadcastService.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A delivery service through which content is provided via broadcast over the * air or online. * * @see http://schema.org/BroadcastService * - * @mixin \Spatie\SchemaOrg\Service */ -class BroadcastService extends BaseType +class BroadcastService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { /** * The area within which users can expect to reach the broadcast service. @@ -144,4 +147,528 @@ public function videoFormat($videoFormat) return $this->setProperty('videoFormat', $videoFormat); } + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BuddhistTemple.php b/src/BuddhistTemple.php index 7b3048a5d..bcd308fca 100644 --- a/src/BuddhistTemple.php +++ b/src/BuddhistTemple.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Buddhist temple. * * @see http://schema.org/BuddhistTemple * - * @mixin \Spatie\SchemaOrg\PlaceOfWorship */ -class BuddhistTemple extends BaseType +class BuddhistTemple extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BusReservation.php b/src/BusReservation.php index e39bbf3f4..c4f752c3f 100644 --- a/src/BusReservation.php +++ b/src/BusReservation.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservation for bus travel. * @@ -11,8 +15,399 @@ * * @see http://schema.org/BusReservation * - * @mixin \Spatie\SchemaOrg\Reservation */ -class BusReservation extends BaseType +class BusReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BusStation.php b/src/BusStation.php index f22d70efa..6e08f403a 100644 --- a/src/BusStation.php +++ b/src/BusStation.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A bus station. * * @see http://schema.org/BusStation * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class BusStation extends BaseType +class BusStation extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BusStop.php b/src/BusStop.php index d03b96336..839a78fbe 100644 --- a/src/BusStop.php +++ b/src/BusStop.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A bus stop. * * @see http://schema.org/BusStop * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class BusStop extends BaseType +class BusStop extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BusTrip.php b/src/BusTrip.php index 3c5dc50a2..7b7d61a07 100644 --- a/src/BusTrip.php +++ b/src/BusTrip.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TripContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A trip on a commercial bus line. * * @see http://schema.org/BusTrip * - * @mixin \Spatie\SchemaOrg\Trip */ -class BusTrip extends BaseType +class BusTrip extends BaseType implements TripContract, IntangibleContract, ThingContract { /** * The stop or station from which the bus arrives. @@ -67,4 +70,250 @@ public function departureBusStop($departureBusStop) return $this->setProperty('departureBusStop', $departureBusStop); } + /** + * The expected arrival time. + * + * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime + * + * @return static + * + * @see http://schema.org/arrivalTime + */ + public function arrivalTime($arrivalTime) + { + return $this->setProperty('arrivalTime', $arrivalTime); + } + + /** + * The expected departure time. + * + * @param \DateTimeInterface|\DateTimeInterface[] $departureTime + * + * @return static + * + * @see http://schema.org/departureTime + */ + public function departureTime($departureTime) + { + return $this->setProperty('departureTime', $departureTime); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BusinessAudience.php b/src/BusinessAudience.php index 9cce4f3c8..5970a6b7b 100644 --- a/src/BusinessAudience.php +++ b/src/BusinessAudience.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AudienceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A set of characteristics belonging to businesses, e.g. who compose an item's * target audience. * * @see http://schema.org/BusinessAudience * - * @mixin \Spatie\SchemaOrg\Audience */ -class BusinessAudience extends BaseType +class BusinessAudience extends BaseType implements AudienceContract, IntangibleContract, ThingContract { /** * The number of employees in an organization e.g. business. @@ -54,4 +57,219 @@ public function yearsInOperation($yearsInOperation) return $this->setProperty('yearsInOperation', $yearsInOperation); } + /** + * The target group associated with a given audience (e.g. veterans, car + * owners, musicians, etc.). + * + * @param string|string[] $audienceType + * + * @return static + * + * @see http://schema.org/audienceType + */ + public function audienceType($audienceType) + { + return $this->setProperty('audienceType', $audienceType); + } + + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BusinessEntityType.php b/src/BusinessEntityType.php index 97a7d32fe..d0b6d5333 100644 --- a/src/BusinessEntityType.php +++ b/src/BusinessEntityType.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A business entity type is a conceptual entity representing the legal form, * the size, the main line of business, the position in the value chain, or any @@ -16,8 +20,193 @@ * * @see http://schema.org/BusinessEntityType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class BusinessEntityType extends BaseType +class BusinessEntityType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BusinessEvent.php b/src/BusinessEvent.php index 30c8e74a1..b19ddd194 100644 --- a/src/BusinessEvent.php +++ b/src/BusinessEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Business event. * * @see http://schema.org/BusinessEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class BusinessEvent extends BaseType +class BusinessEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BusinessFunction.php b/src/BusinessFunction.php index 4c98d3993..ce244840b 100644 --- a/src/BusinessFunction.php +++ b/src/BusinessFunction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The business function specifies the type of activity or access (i.e., the * bundle of rights) offered by the organization or business person through the @@ -22,8 +26,193 @@ * * @see http://schema.org/BusinessFunction * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class BusinessFunction extends BaseType +class BusinessFunction extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/BuyAction.php b/src/BuyAction.php index d5dbb8c7c..e3944a511 100644 --- a/src/BuyAction.php +++ b/src/BuyAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of giving money to a seller in exchange for goods or services * rendered. An agent buys an object, product, or service from a seller for a @@ -9,9 +13,8 @@ * * @see http://schema.org/BuyAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class BuyAction extends BaseType +class BuyAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** * An entity which offers (sells / leases / lends / loans) the services / @@ -56,4 +59,444 @@ public function warrantyPromise($warrantyPromise) return $this->setProperty('warrantyPromise', $warrantyPromise); } + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CableOrSatelliteService.php b/src/CableOrSatelliteService.php index 8a7eaf95f..d4cb1bb17 100644 --- a/src/CableOrSatelliteService.php +++ b/src/CableOrSatelliteService.php @@ -2,14 +2,541 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A service which provides access to media programming like TV or radio. Access * may be via cable or satellite. * * @see http://schema.org/CableOrSatelliteService * - * @mixin \Spatie\SchemaOrg\Service */ -class CableOrSatelliteService extends BaseType +class CableOrSatelliteService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CafeOrCoffeeShop.php b/src/CafeOrCoffeeShop.php index 0d8d18c3d..c848ca651 100644 --- a/src/CafeOrCoffeeShop.php +++ b/src/CafeOrCoffeeShop.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A cafe or coffee shop. * * @see http://schema.org/CafeOrCoffeeShop * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class CafeOrCoffeeShop extends BaseType +class CafeOrCoffeeShop extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Campground.php b/src/Campground.php index d4e027665..359709570 100644 --- a/src/Campground.php +++ b/src/Campground.php @@ -2,6 +2,13 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A camping site, campsite, or [[Campground]] is a place used for overnight * stay in the outdoors, typically containing individual [[CampingPitch]] @@ -24,9 +31,1435 @@ * * @see http://schema.org/Campground * - * @mixin \Spatie\SchemaOrg\CivicStructure - * @mixin \Spatie\SchemaOrg\LodgingBusiness */ -class Campground extends BaseType +class Campground extends BaseType implements CivicStructureContract, LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * + * @param Language|Language[]|string|string[] $availableLanguage + * + * @return static + * + * @see http://schema.org/availableLanguage + */ + public function availableLanguage($availableLanguage) + { + return $this->setProperty('availableLanguage', $availableLanguage); + } + + /** + * The earliest someone may check into a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * + * @return static + * + * @see http://schema.org/checkinTime + */ + public function checkinTime($checkinTime) + { + return $this->setProperty('checkinTime', $checkinTime); + } + + /** + * The latest someone may check out of a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * + * @return static + * + * @see http://schema.org/checkoutTime + */ + public function checkoutTime($checkoutTime) + { + return $this->setProperty('checkoutTime', $checkoutTime); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + } diff --git a/src/CampingPitch.php b/src/CampingPitch.php index c0c821403..b126c813c 100644 --- a/src/CampingPitch.php +++ b/src/CampingPitch.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A [[CampingPitch]] is an individual place for overnight stay in the outdoors, * typically being part of a larger camping site, or [[Campground]]. @@ -23,8 +27,735 @@ * * @see http://schema.org/CampingPitch * - * @mixin \Spatie\SchemaOrg\Accommodation */ -class CampingPitch extends BaseType +class CampingPitch extends BaseType implements AccommodationContract, PlaceContract, ThingContract { + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indications regarding the permitted usage of the accommodation. + * + * @param string|string[] $permittedUsage + * + * @return static + * + * @see http://schema.org/permittedUsage + */ + public function permittedUsage($permittedUsage) + { + return $this->setProperty('permittedUsage', $permittedUsage); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Canal.php b/src/Canal.php index 70135c658..0b16fa6ae 100644 --- a/src/Canal.php +++ b/src/Canal.php @@ -2,13 +2,683 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BodyOfWaterContract; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A canal, like the Panama Canal. * * @see http://schema.org/Canal * - * @mixin \Spatie\SchemaOrg\BodyOfWater */ -class Canal extends BaseType +class Canal extends BaseType implements BodyOfWaterContract, LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CancelAction.php b/src/CancelAction.php index d81901375..2f648d76b 100644 --- a/src/CancelAction.php +++ b/src/CancelAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlanActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of asserting that a future event/action is no longer going to happen. * @@ -11,8 +16,386 @@ * * @see http://schema.org/CancelAction * - * @mixin \Spatie\SchemaOrg\PlanAction */ -class CancelAction extends BaseType +class CancelAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract { + /** + * The time the object is scheduled to. + * + * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime + * + * @return static + * + * @see http://schema.org/scheduledTime + */ + public function scheduledTime($scheduledTime) + { + return $this->setProperty('scheduledTime', $scheduledTime); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Car.php b/src/Car.php index 55436d4a2..308da22b6 100644 --- a/src/Car.php +++ b/src/Car.php @@ -2,13 +2,1117 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\VehicleContract; +use \Spatie\SchemaOrg\Contracts\ProductContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A car is a wheeled, self-powered motor vehicle used for transportation. * * @see http://schema.org/Car * - * @mixin \Spatie\SchemaOrg\Vehicle */ -class Car extends BaseType +class Car extends BaseType implements VehicleContract, ProductContract, ThingContract { + /** + * The available volume for cargo or luggage. For automobiles, this is + * usually the trunk volume. + * + * Typical unit code(s): LTR for liters, FTQ for cubic foot/feet + * + * Note: You can use [[minValue]] and [[maxValue]] to indicate ranges. + * + * @param QuantitativeValue|QuantitativeValue[] $cargoVolume + * + * @return static + * + * @see http://schema.org/cargoVolume + */ + public function cargoVolume($cargoVolume) + { + return $this->setProperty('cargoVolume', $cargoVolume); + } + + /** + * The date of the first registration of the vehicle with the respective + * public authorities. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateVehicleFirstRegistered + * + * @return static + * + * @see http://schema.org/dateVehicleFirstRegistered + */ + public function dateVehicleFirstRegistered($dateVehicleFirstRegistered) + { + return $this->setProperty('dateVehicleFirstRegistered', $dateVehicleFirstRegistered); + } + + /** + * The drive wheel configuration, i.e. which roadwheels will receive torque + * from the vehicle's engine via the drivetrain. + * + * @param DriveWheelConfigurationValue|DriveWheelConfigurationValue[]|string|string[] $driveWheelConfiguration + * + * @return static + * + * @see http://schema.org/driveWheelConfiguration + */ + public function driveWheelConfiguration($driveWheelConfiguration) + { + return $this->setProperty('driveWheelConfiguration', $driveWheelConfiguration); + } + + /** + * The amount of fuel consumed for traveling a particular distance or + * temporal duration with the given vehicle (e.g. liters per 100 km). + * + * * Note 1: There are unfortunately no standard unit codes for liters per + * 100 km. Use [[unitText]] to indicate the unit of measurement, e.g. L/100 + * km. + * * Note 2: There are two ways of indicating the fuel consumption, + * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] + * (e.g. 30 miles per gallon). They are reciprocal. + * * Note 3: Often, the absolute value is useful only when related to + * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can + * use [[valueReference]] to link the value for the fuel consumption to + * another value. + * + * @param QuantitativeValue|QuantitativeValue[] $fuelConsumption + * + * @return static + * + * @see http://schema.org/fuelConsumption + */ + public function fuelConsumption($fuelConsumption) + { + return $this->setProperty('fuelConsumption', $fuelConsumption); + } + + /** + * The distance traveled per unit of fuel used; most commonly miles per + * gallon (mpg) or kilometers per liter (km/L). + * + * * Note 1: There are unfortunately no standard unit codes for miles per + * gallon or kilometers per liter. Use [[unitText]] to indicate the unit of + * measurement, e.g. mpg or km/L. + * * Note 2: There are two ways of indicating the fuel consumption, + * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] + * (e.g. 30 miles per gallon). They are reciprocal. + * * Note 3: Often, the absolute value is useful only when related to + * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can + * use [[valueReference]] to link the value for the fuel economy to another + * value. + * + * @param QuantitativeValue|QuantitativeValue[] $fuelEfficiency + * + * @return static + * + * @see http://schema.org/fuelEfficiency + */ + public function fuelEfficiency($fuelEfficiency) + { + return $this->setProperty('fuelEfficiency', $fuelEfficiency); + } + + /** + * The type of fuel suitable for the engine or engines of the vehicle. If + * the vehicle has only one engine, this property can be attached directly + * to the vehicle. + * + * @param QualitativeValue|QualitativeValue[]|string|string[] $fuelType + * + * @return static + * + * @see http://schema.org/fuelType + */ + public function fuelType($fuelType) + { + return $this->setProperty('fuelType', $fuelType); + } + + /** + * A textual description of known damages, both repaired and unrepaired. + * + * @param string|string[] $knownVehicleDamages + * + * @return static + * + * @see http://schema.org/knownVehicleDamages + */ + public function knownVehicleDamages($knownVehicleDamages) + { + return $this->setProperty('knownVehicleDamages', $knownVehicleDamages); + } + + /** + * The total distance travelled by the particular vehicle since its initial + * production, as read from its odometer. + * + * Typical unit code(s): KMT for kilometers, SMI for statute miles + * + * @param QuantitativeValue|QuantitativeValue[] $mileageFromOdometer + * + * @return static + * + * @see http://schema.org/mileageFromOdometer + */ + public function mileageFromOdometer($mileageFromOdometer) + { + return $this->setProperty('mileageFromOdometer', $mileageFromOdometer); + } + + /** + * The number or type of airbags in the vehicle. + * + * @param float|float[]|int|int[]|string|string[] $numberOfAirbags + * + * @return static + * + * @see http://schema.org/numberOfAirbags + */ + public function numberOfAirbags($numberOfAirbags) + { + return $this->setProperty('numberOfAirbags', $numberOfAirbags); + } + + /** + * The number of axles. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfAxles + * + * @return static + * + * @see http://schema.org/numberOfAxles + */ + public function numberOfAxles($numberOfAxles) + { + return $this->setProperty('numberOfAxles', $numberOfAxles); + } + + /** + * The number of doors. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfDoors + * + * @return static + * + * @see http://schema.org/numberOfDoors + */ + public function numberOfDoors($numberOfDoors) + { + return $this->setProperty('numberOfDoors', $numberOfDoors); + } + + /** + * The total number of forward gears available for the transmission system + * of the vehicle. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfForwardGears + * + * @return static + * + * @see http://schema.org/numberOfForwardGears + */ + public function numberOfForwardGears($numberOfForwardGears) + { + return $this->setProperty('numberOfForwardGears', $numberOfForwardGears); + } + + /** + * The number of owners of the vehicle, including the current one. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfPreviousOwners + * + * @return static + * + * @see http://schema.org/numberOfPreviousOwners + */ + public function numberOfPreviousOwners($numberOfPreviousOwners) + { + return $this->setProperty('numberOfPreviousOwners', $numberOfPreviousOwners); + } + + /** + * The date of production of the item, e.g. vehicle. + * + * @param \DateTimeInterface|\DateTimeInterface[] $productionDate + * + * @return static + * + * @see http://schema.org/productionDate + */ + public function productionDate($productionDate) + { + return $this->setProperty('productionDate', $productionDate); + } + + /** + * The date the item e.g. vehicle was purchased by the current owner. + * + * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate + * + * @return static + * + * @see http://schema.org/purchaseDate + */ + public function purchaseDate($purchaseDate) + { + return $this->setProperty('purchaseDate', $purchaseDate); + } + + /** + * The position of the steering wheel or similar device (mostly for cars). + * + * @param SteeringPositionValue|SteeringPositionValue[] $steeringPosition + * + * @return static + * + * @see http://schema.org/steeringPosition + */ + public function steeringPosition($steeringPosition) + { + return $this->setProperty('steeringPosition', $steeringPosition); + } + + /** + * A short text indicating the configuration of the vehicle, e.g. '5dr + * hatchback ST 2.5 MT 225 hp' or 'limited edition'. + * + * @param string|string[] $vehicleConfiguration + * + * @return static + * + * @see http://schema.org/vehicleConfiguration + */ + public function vehicleConfiguration($vehicleConfiguration) + { + return $this->setProperty('vehicleConfiguration', $vehicleConfiguration); + } + + /** + * Information about the engine or engines of the vehicle. + * + * @param EngineSpecification|EngineSpecification[] $vehicleEngine + * + * @return static + * + * @see http://schema.org/vehicleEngine + */ + public function vehicleEngine($vehicleEngine) + { + return $this->setProperty('vehicleEngine', $vehicleEngine); + } + + /** + * The Vehicle Identification Number (VIN) is a unique serial number used by + * the automotive industry to identify individual motor vehicles. + * + * @param string|string[] $vehicleIdentificationNumber + * + * @return static + * + * @see http://schema.org/vehicleIdentificationNumber + */ + public function vehicleIdentificationNumber($vehicleIdentificationNumber) + { + return $this->setProperty('vehicleIdentificationNumber', $vehicleIdentificationNumber); + } + + /** + * The color or color combination of the interior of the vehicle. + * + * @param string|string[] $vehicleInteriorColor + * + * @return static + * + * @see http://schema.org/vehicleInteriorColor + */ + public function vehicleInteriorColor($vehicleInteriorColor) + { + return $this->setProperty('vehicleInteriorColor', $vehicleInteriorColor); + } + + /** + * The type or material of the interior of the vehicle (e.g. synthetic + * fabric, leather, wood, etc.). While most interior types are characterized + * by the material used, an interior type can also be based on vehicle usage + * or target audience. + * + * @param string|string[] $vehicleInteriorType + * + * @return static + * + * @see http://schema.org/vehicleInteriorType + */ + public function vehicleInteriorType($vehicleInteriorType) + { + return $this->setProperty('vehicleInteriorType', $vehicleInteriorType); + } + + /** + * The release date of a vehicle model (often used to differentiate versions + * of the same make and model). + * + * @param \DateTimeInterface|\DateTimeInterface[] $vehicleModelDate + * + * @return static + * + * @see http://schema.org/vehicleModelDate + */ + public function vehicleModelDate($vehicleModelDate) + { + return $this->setProperty('vehicleModelDate', $vehicleModelDate); + } + + /** + * The number of passengers that can be seated in the vehicle, both in terms + * of the physical space available, and in terms of limitations set by law. + * + * Typical unit code(s): C62 for persons. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $vehicleSeatingCapacity + * + * @return static + * + * @see http://schema.org/vehicleSeatingCapacity + */ + public function vehicleSeatingCapacity($vehicleSeatingCapacity) + { + return $this->setProperty('vehicleSeatingCapacity', $vehicleSeatingCapacity); + } + + /** + * Indicates whether the vehicle has been used for special purposes, like + * commercial rental, driving school, or as a taxi. The legislation in many + * countries requires this information to be revealed when offering a car + * for sale. + * + * @param string|string[] $vehicleSpecialUsage + * + * @return static + * + * @see http://schema.org/vehicleSpecialUsage + */ + public function vehicleSpecialUsage($vehicleSpecialUsage) + { + return $this->setProperty('vehicleSpecialUsage', $vehicleSpecialUsage); + } + + /** + * The type of component used for transmitting the power from a rotating + * power source to the wheels or other relevant component(s) ("gearbox" for + * cars). + * + * @param QualitativeValue|QualitativeValue[]|string|string[] $vehicleTransmission + * + * @return static + * + * @see http://schema.org/vehicleTransmission + */ + public function vehicleTransmission($vehicleTransmission) + { + return $this->setProperty('vehicleTransmission', $vehicleTransmission); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * The color of the product. + * + * @param string|string[] $color + * + * @return static + * + * @see http://schema.org/color + */ + public function color($color) + { + return $this->setProperty('color', $color); + } + + /** + * The depth of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth + * + * @return static + * + * @see http://schema.org/depth + */ + public function depth($depth) + { + return $this->setProperty('depth', $depth); + } + + /** + * The GTIN-12 code of the product, or the product to which the offer + * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a + * U.P.C. Company Prefix, Item Reference, and Check Digit used to identify + * trade items. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin12 + * + * @return static + * + * @see http://schema.org/gtin12 + */ + public function gtin12($gtin12) + { + return $this->setProperty('gtin12', $gtin12); + } + + /** + * The GTIN-13 code of the product, or the product to which the offer + * refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former + * 12-digit UPC codes can be converted into a GTIN-13 code by simply adding + * a preceeding zero. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin13 + * + * @return static + * + * @see http://schema.org/gtin13 + */ + public function gtin13($gtin13) + { + return $this->setProperty('gtin13', $gtin13); + } + + /** + * The GTIN-14 code of the product, or the product to which the offer + * refers. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin14 + * + * @return static + * + * @see http://schema.org/gtin14 + */ + public function gtin14($gtin14) + { + return $this->setProperty('gtin14', $gtin14); + } + + /** + * The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of + * the product, or the product to which the offer refers. This code is also + * known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin8 + * + * @return static + * + * @see http://schema.org/gtin8 + */ + public function gtin8($gtin8) + { + return $this->setProperty('gtin8', $gtin8); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is an accessory or spare part. + * + * @param Product|Product[] $isAccessoryOrSparePartFor + * + * @return static + * + * @see http://schema.org/isAccessoryOrSparePartFor + */ + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor) + { + return $this->setProperty('isAccessoryOrSparePartFor', $isAccessoryOrSparePartFor); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is a consumable. + * + * @param Product|Product[] $isConsumableFor + * + * @return static + * + * @see http://schema.org/isConsumableFor + */ + public function isConsumableFor($isConsumableFor) + { + return $this->setProperty('isConsumableFor', $isConsumableFor); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * A predefined value from OfferItemCondition or a textual description of + * the condition of the product or service, or the products or services + * included in the offer. + * + * @param OfferItemCondition|OfferItemCondition[] $itemCondition + * + * @return static + * + * @see http://schema.org/itemCondition + */ + public function itemCondition($itemCondition) + { + return $this->setProperty('itemCondition', $itemCondition); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The manufacturer of the product. + * + * @param Organization|Organization[] $manufacturer + * + * @return static + * + * @see http://schema.org/manufacturer + */ + public function manufacturer($manufacturer) + { + return $this->setProperty('manufacturer', $manufacturer); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * The model of the product. Use with the URL of a ProductModel or a textual + * representation of the model identifier. The URL of the ProductModel can + * be from an external source. It is recommended to additionally provide + * strong product identifiers via the gtin8/gtin13/gtin14 and mpn + * properties. + * + * @param ProductModel|ProductModel[]|string|string[] $model + * + * @return static + * + * @see http://schema.org/model + */ + public function model($model) + { + return $this->setProperty('model', $model); + } + + /** + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. + * + * @param string|string[] $mpn + * + * @return static + * + * @see http://schema.org/mpn + */ + public function mpn($mpn) + { + return $this->setProperty('mpn', $mpn); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The product identifier, such as ISBN. For example: ``` meta + * itemprop="productID" content="isbn:123-456-789" ```. + * + * @param string|string[] $productID + * + * @return static + * + * @see http://schema.org/productID + */ + public function productID($productID) + { + return $this->setProperty('productID', $productID); + } + + /** + * The release date of a product or product model. This can be used to + * distinguish the exact variant of a product. + * + * @param \DateTimeInterface|\DateTimeInterface[] $releaseDate + * + * @return static + * + * @see http://schema.org/releaseDate + */ + public function releaseDate($releaseDate) + { + return $this->setProperty('releaseDate', $releaseDate); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a + * product or service, or the product to which the offer refers. + * + * @param string|string[] $sku + * + * @return static + * + * @see http://schema.org/sku + */ + public function sku($sku) + { + return $this->setProperty('sku', $sku); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * The weight of the product or person. + * + * @param QuantitativeValue|QuantitativeValue[] $weight + * + * @return static + * + * @see http://schema.org/weight + */ + public function weight($weight) + { + return $this->setProperty('weight', $weight); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Casino.php b/src/Casino.php index ed16e254c..a310052fe 100644 --- a/src/Casino.php +++ b/src/Casino.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A casino. * * @see http://schema.org/Casino * - * @mixin \Spatie\SchemaOrg\EntertainmentBusiness */ -class Casino extends BaseType +class Casino extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/CatholicChurch.php b/src/CatholicChurch.php index 9242445ef..8b7e962a3 100644 --- a/src/CatholicChurch.php +++ b/src/CatholicChurch.php @@ -2,13 +2,713 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ChurchContract; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Catholic church. * * @see http://schema.org/CatholicChurch * - * @mixin \Spatie\SchemaOrg\Church */ -class CatholicChurch extends BaseType +class CatholicChurch extends BaseType implements ChurchContract, PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Cemetery.php b/src/Cemetery.php index 7af4a3300..7b3d165b2 100644 --- a/src/Cemetery.php +++ b/src/Cemetery.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A graveyard. * * @see http://schema.org/Cemetery * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Cemetery extends BaseType +class Cemetery extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CheckAction.php b/src/CheckAction.php index 988173738..46d842f8b 100644 --- a/src/CheckAction.php +++ b/src/CheckAction.php @@ -2,14 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FindActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent inspects, determines, investigates, inquires, or examines an * object's accuracy, quality, condition, or state. * * @see http://schema.org/CheckAction * - * @mixin \Spatie\SchemaOrg\FindAction */ -class CheckAction extends BaseType +class CheckAction extends BaseType implements FindActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CheckInAction.php b/src/CheckInAction.php index 90b15374d..8668db273 100644 --- a/src/CheckInAction.php +++ b/src/CheckInAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of an agent communicating (service provider, social media, etc) their * arrival by registering/confirming for a previously reserved service (e.g. @@ -19,8 +24,432 @@ * * @see http://schema.org/CheckInAction * - * @mixin \Spatie\SchemaOrg\CommunicateAction */ -class CheckInAction extends BaseType +class CheckInAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CheckOutAction.php b/src/CheckOutAction.php index 01d4ba561..b0523cc18 100644 --- a/src/CheckOutAction.php +++ b/src/CheckOutAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of an agent communicating (service provider, social media, etc) their * departure of a previously reserved service (e.g. flight check in) or place @@ -17,8 +22,432 @@ * * @see http://schema.org/CheckOutAction * - * @mixin \Spatie\SchemaOrg\CommunicateAction */ -class CheckOutAction extends BaseType +class CheckOutAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CheckoutPage.php b/src/CheckoutPage.php index c35fbd838..8923ce51f 100644 --- a/src/CheckoutPage.php +++ b/src/CheckoutPage.php @@ -2,13 +2,1691 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web page type: Checkout page. * * @see http://schema.org/CheckoutPage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class CheckoutPage extends BaseType +class CheckoutPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ChildCare.php b/src/ChildCare.php index 0b1d92f99..b96ef26e4 100644 --- a/src/ChildCare.php +++ b/src/ChildCare.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Childcare center. * * @see http://schema.org/ChildCare * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class ChildCare extends BaseType +class ChildCare extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ChildrensEvent.php b/src/ChildrensEvent.php index fd58d8045..c01ffa52f 100644 --- a/src/ChildrensEvent.php +++ b/src/ChildrensEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Children's event. * * @see http://schema.org/ChildrensEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class ChildrensEvent extends BaseType +class ChildrensEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ChooseAction.php b/src/ChooseAction.php index d9aa7ba7d..8b787164b 100644 --- a/src/ChooseAction.php +++ b/src/ChooseAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of expressing a preference from a set of options or a large or * unbounded set of choices/options. * * @see http://schema.org/ChooseAction * - * @mixin \Spatie\SchemaOrg\AssessAction */ -class ChooseAction extends BaseType +class ChooseAction extends BaseType implements AssessActionContract, ActionContract, ThingContract { /** * A sub property of object. The options subject to this action. @@ -40,4 +43,369 @@ public function option($option) return $this->setProperty('option', $option); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Church.php b/src/Church.php index 74a87a73c..9fa363602 100644 --- a/src/Church.php +++ b/src/Church.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A church. * * @see http://schema.org/Church * - * @mixin \Spatie\SchemaOrg\PlaceOfWorship */ -class Church extends BaseType +class Church extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/City.php b/src/City.php index 1abcb8ce0..65f43bd50 100644 --- a/src/City.php +++ b/src/City.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A city or town. * * @see http://schema.org/City * - * @mixin \Spatie\SchemaOrg\AdministrativeArea */ -class City extends BaseType +class City extends BaseType implements AdministrativeAreaContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CityHall.php b/src/CityHall.php index 991acefbb..9974aa9d2 100644 --- a/src/CityHall.php +++ b/src/CityHall.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A city hall. * * @see http://schema.org/CityHall * - * @mixin \Spatie\SchemaOrg\GovernmentBuilding */ -class CityHall extends BaseType +class CityHall extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CivicStructure.php b/src/CivicStructure.php index 3533d7947..1ee5a484b 100644 --- a/src/CivicStructure.php +++ b/src/CivicStructure.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A public structure, such as a town hall or concert hall. * * @see http://schema.org/CivicStructure * - * @mixin \Spatie\SchemaOrg\Place */ -class CivicStructure extends BaseType +class CivicStructure extends BaseType implements PlaceContract, ThingContract { /** * The general opening hours for a business. Opening hours can be specified @@ -40,4 +42,670 @@ public function openingHours($openingHours) return $this->setProperty('openingHours', $openingHours); } + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ClaimReview.php b/src/ClaimReview.php index a31919fac..9a0dde12f 100644 --- a/src/ClaimReview.php +++ b/src/ClaimReview.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReviewContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A fact-checking review of claims made (or reported) in some creative work * (referenced via itemReviewed). * * @see http://schema.org/ClaimReview * - * @mixin \Spatie\SchemaOrg\Review */ -class ClaimReview extends BaseType +class ClaimReview extends BaseType implements ReviewContract, CreativeWorkContract, ThingContract { /** * A short summary of the specific claims reviewed in a ClaimReview. @@ -26,4 +29,1569 @@ public function claimReviewed($claimReviewed) return $this->setProperty('claimReviewed', $claimReviewed); } + /** + * The item that is being reviewed/rated. + * + * @param Thing|Thing[] $itemReviewed + * + * @return static + * + * @see http://schema.org/itemReviewed + */ + public function itemReviewed($itemReviewed) + { + return $this->setProperty('itemReviewed', $itemReviewed); + } + + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + + /** + * The actual body of the review. + * + * @param string|string[] $reviewBody + * + * @return static + * + * @see http://schema.org/reviewBody + */ + public function reviewBody($reviewBody) + { + return $this->setProperty('reviewBody', $reviewBody); + } + + /** + * The rating given in this review. Note that reviews can themselves be + * rated. The ```reviewRating``` applies to rating given by the review. The + * [[aggregateRating]] property applies to the review itself, as a creative + * work. + * + * @param Rating|Rating[] $reviewRating + * + * @return static + * + * @see http://schema.org/reviewRating + */ + public function reviewRating($reviewRating) + { + return $this->setProperty('reviewRating', $reviewRating); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Clip.php b/src/Clip.php index 93242ecef..3dabc4654 100644 --- a/src/Clip.php +++ b/src/Clip.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A short TV or radio program or a segment/part of a program. * * @see http://schema.org/Clip * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Clip extends BaseType +class Clip extends BaseType implements CreativeWorkContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -143,4 +145,1509 @@ public function partOfSeries($partOfSeries) return $this->setProperty('partOfSeries', $partOfSeries); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ClothingStore.php b/src/ClothingStore.php index 23c520061..2c55d1e1f 100644 --- a/src/ClothingStore.php +++ b/src/ClothingStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A clothing store. * * @see http://schema.org/ClothingStore * - * @mixin \Spatie\SchemaOrg\Store */ -class ClothingStore extends BaseType +class ClothingStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Code.php b/src/Code.php index 7d2f8c61d..8ab3e2ef5 100644 --- a/src/Code.php +++ b/src/Code.php @@ -2,14 +2,1521 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Computer programming source code. Example: Full (compile ready) solutions, * code snippet samples, scripts, templates. * * @see http://schema.org/Code * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Code extends BaseType +class Code extends BaseType implements CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CollectionPage.php b/src/CollectionPage.php index dc0e20d45..01f700bb1 100644 --- a/src/CollectionPage.php +++ b/src/CollectionPage.php @@ -2,13 +2,1691 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web page type: Collection page. * * @see http://schema.org/CollectionPage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class CollectionPage extends BaseType +class CollectionPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CollegeOrUniversity.php b/src/CollegeOrUniversity.php index aeb000dea..21833e8e4 100644 --- a/src/CollegeOrUniversity.php +++ b/src/CollegeOrUniversity.php @@ -2,13 +2,952 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EducationalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A college, university, or other third-level educational institution. * * @see http://schema.org/CollegeOrUniversity * - * @mixin \Spatie\SchemaOrg\EducationalOrganization */ -class CollegeOrUniversity extends BaseType +class CollegeOrUniversity extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ComedyClub.php b/src/ComedyClub.php index 80ad38d20..e41074e41 100644 --- a/src/ComedyClub.php +++ b/src/ComedyClub.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A comedy club. * * @see http://schema.org/ComedyClub * - * @mixin \Spatie\SchemaOrg\EntertainmentBusiness */ -class ComedyClub extends BaseType +class ComedyClub extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ComedyEvent.php b/src/ComedyEvent.php index 0c28d265e..31c4bcb83 100644 --- a/src/ComedyEvent.php +++ b/src/ComedyEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Comedy event. * * @see http://schema.org/ComedyEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class ComedyEvent extends BaseType +class ComedyEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Comment.php b/src/Comment.php index 7a117212c..674907a17 100644 --- a/src/Comment.php +++ b/src/Comment.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A comment on an item - for example, a comment on a blog post. The comment's * content is expressed via the [[text]] property, and its topic via [[about]], @@ -9,9 +12,8 @@ * * @see http://schema.org/Comment * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Comment extends BaseType +class Comment extends BaseType implements CreativeWorkContract, ThingContract { /** * The number of downvotes this question, answer or comment has received @@ -57,4 +59,1509 @@ public function upvoteCount($upvoteCount) return $this->setProperty('upvoteCount', $upvoteCount); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CommentAction.php b/src/CommentAction.php index be57ff1a1..27ca1f2d3 100644 --- a/src/CommentAction.php +++ b/src/CommentAction.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of generating a comment about a subject. * * @see http://schema.org/CommentAction * - * @mixin \Spatie\SchemaOrg\CommunicateAction */ -class CommentAction extends BaseType +class CommentAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** * A sub property of result. The Comment created or sent as a result of this @@ -26,4 +30,429 @@ public function resultComment($resultComment) return $this->setProperty('resultComment', $resultComment); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CommunicateAction.php b/src/CommunicateAction.php index 2fe1ef9e4..7a24dc5b3 100644 --- a/src/CommunicateAction.php +++ b/src/CommunicateAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of conveying information to another person via a communication medium * (instrument) such as speech, email, or telephone conversation. * * @see http://schema.org/CommunicateAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class CommunicateAction extends BaseType +class CommunicateAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { /** * The subject matter of the content. @@ -72,4 +75,369 @@ public function recipient($recipient) return $this->setProperty('recipient', $recipient); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CompoundPriceSpecification.php b/src/CompoundPriceSpecification.php index 6b6191618..ce8bc2c7e 100644 --- a/src/CompoundPriceSpecification.php +++ b/src/CompoundPriceSpecification.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PriceSpecificationContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A compound price specification is one that bundles multiple prices that all * apply in combination for different dimensions of consumption. Use the name @@ -10,9 +15,8 @@ * * @see http://schema.org/CompoundPriceSpecification * - * @mixin \Spatie\SchemaOrg\PriceSpecification */ -class CompoundPriceSpecification extends BaseType +class CompoundPriceSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract { /** * This property links to all [[UnitPriceSpecification]] nodes that apply in @@ -29,4 +33,355 @@ public function priceComponent($priceComponent) return $this->setProperty('priceComponent', $priceComponent); } + /** + * The interval and unit of measurement of ordering quantities for which the + * offer or price specification is valid. This allows e.g. specifying that a + * certain freight charge is valid only for a certain quantity. + * + * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity + * + * @return static + * + * @see http://schema.org/eligibleQuantity + */ + public function eligibleQuantity($eligibleQuantity) + { + return $this->setProperty('eligibleQuantity', $eligibleQuantity); + } + + /** + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. + * + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * + * @return static + * + * @see http://schema.org/eligibleTransactionVolume + */ + public function eligibleTransactionVolume($eligibleTransactionVolume) + { + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + } + + /** + * The highest price if the price is a range. + * + * @param float|float[]|int|int[] $maxPrice + * + * @return static + * + * @see http://schema.org/maxPrice + */ + public function maxPrice($maxPrice) + { + return $this->setProperty('maxPrice', $maxPrice); + } + + /** + * The lowest price if the price is a range. + * + * @param float|float[]|int|int[] $minPrice + * + * @return static + * + * @see http://schema.org/minPrice + */ + public function minPrice($minPrice) + { + return $this->setProperty('minPrice', $minPrice); + } + + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * + * @return static + * + * @see http://schema.org/validThrough + */ + public function validThrough($validThrough) + { + return $this->setProperty('validThrough', $validThrough); + } + + /** + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. + * + * @param bool|bool[] $valueAddedTaxIncluded + * + * @return static + * + * @see http://schema.org/valueAddedTaxIncluded + */ + public function valueAddedTaxIncluded($valueAddedTaxIncluded) + { + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ComputerLanguage.php b/src/ComputerLanguage.php index b095f97b2..299300339 100644 --- a/src/ComputerLanguage.php +++ b/src/ComputerLanguage.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * This type covers computer programming languages such as Scheme and Lisp, as * well as other language-like computer representations. Natural languages are @@ -9,8 +12,193 @@ * * @see http://schema.org/ComputerLanguage * - * @mixin \Spatie\SchemaOrg\Intangible */ -class ComputerLanguage extends BaseType +class ComputerLanguage extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ComputerStore.php b/src/ComputerStore.php index e26f77b1f..d00e47b2a 100644 --- a/src/ComputerStore.php +++ b/src/ComputerStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A computer store. * * @see http://schema.org/ComputerStore * - * @mixin \Spatie\SchemaOrg\Store */ -class ComputerStore extends BaseType +class ComputerStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ConfirmAction.php b/src/ConfirmAction.php index e93e6af8e..52b83ee80 100644 --- a/src/ConfirmAction.php +++ b/src/ConfirmAction.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InformActionContract; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of notifying someone that a future event/action is going to happen as * expected. @@ -12,8 +18,447 @@ * * @see http://schema.org/ConfirmAction * - * @mixin \Spatie\SchemaOrg\InformAction */ -class ConfirmAction extends BaseType +class ConfirmAction extends BaseType implements InformActionContract, CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ConsumeAction.php b/src/ConsumeAction.php index 80844e645..6d2434964 100644 --- a/src/ConsumeAction.php +++ b/src/ConsumeAction.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of ingesting information/resources/food. * * @see http://schema.org/ConsumeAction * - * @mixin \Spatie\SchemaOrg\Action */ -class ConsumeAction extends BaseType +class ConsumeAction extends BaseType implements ActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an @@ -43,4 +45,369 @@ public function expectsAcceptanceOf($expectsAcceptanceOf) return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ContactPage.php b/src/ContactPage.php index 2823f8aa3..3d82c9fd2 100644 --- a/src/ContactPage.php +++ b/src/ContactPage.php @@ -2,13 +2,1691 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web page type: Contact page. * * @see http://schema.org/ContactPage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class ContactPage extends BaseType +class ContactPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ContactPoint.php b/src/ContactPoint.php index 276d16c85..bad6d6a58 100644 --- a/src/ContactPoint.php +++ b/src/ContactPoint.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A contact point—for example, a Customer Complaints department. * * @see http://schema.org/ContactPoint * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class ContactPoint extends BaseType +class ContactPoint extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The geographic area where a service or offered item is provided. @@ -159,4 +162,190 @@ public function telephone($telephone) return $this->setProperty('telephone', $telephone); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ContactPointOption.php b/src/ContactPointOption.php index ff38ff968..f26211793 100644 --- a/src/ContactPointOption.php +++ b/src/ContactPointOption.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Enumerated options related to a ContactPoint. * * @see http://schema.org/ContactPointOption * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class ContactPointOption extends BaseType +class ContactPointOption extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * Uses devices to support users with hearing impairments. @@ -25,4 +28,190 @@ class ContactPointOption extends BaseType */ const TollFree = 'http://schema.org/TollFree'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Continent.php b/src/Continent.php index 85a50e141..c72f03242 100644 --- a/src/Continent.php +++ b/src/Continent.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * One of the continents (for example, Europe or Africa). * * @see http://schema.org/Continent * - * @mixin \Spatie\SchemaOrg\Landform */ -class Continent extends BaseType +class Continent extends BaseType implements LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Contracts/AMRadioChannelContract.php b/src/Contracts/AMRadioChannelContract.php new file mode 100644 index 000000000..bef6c491d --- /dev/null +++ b/src/Contracts/AMRadioChannelContract.php @@ -0,0 +1,43 @@ +setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ConvenienceStore.php b/src/ConvenienceStore.php index 5b1ef41a2..f50990f9c 100644 --- a/src/ConvenienceStore.php +++ b/src/ConvenienceStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A convenience store. * * @see http://schema.org/ConvenienceStore * - * @mixin \Spatie\SchemaOrg\Store */ -class ConvenienceStore extends BaseType +class ConvenienceStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Conversation.php b/src/Conversation.php index 600037fb6..08a80a7a9 100644 --- a/src/Conversation.php +++ b/src/Conversation.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * One or more messages between organizations or people on a particular topic. * Individual messages can be linked to the conversation with isPartOf or @@ -9,8 +12,1512 @@ * * @see http://schema.org/Conversation * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Conversation extends BaseType +class Conversation extends BaseType implements CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CookAction.php b/src/CookAction.php index f037501b3..cb8fe51d6 100644 --- a/src/CookAction.php +++ b/src/CookAction.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of producing/preparing food. * * @see http://schema.org/CookAction * - * @mixin \Spatie\SchemaOrg\CreateAction */ -class CookAction extends BaseType +class CookAction extends BaseType implements CreateActionContract, ActionContract, ThingContract { /** * A sub property of location. The specific food establishment where the @@ -56,4 +59,369 @@ public function recipe($recipe) return $this->setProperty('recipe', $recipe); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Corporation.php b/src/Corporation.php index 03432e483..6d1d543af 100644 --- a/src/Corporation.php +++ b/src/Corporation.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Organization: A business corporation. * * @see http://schema.org/Corporation * - * @mixin \Spatie\SchemaOrg\Organization */ -class Corporation extends BaseType +class Corporation extends BaseType implements OrganizationContract, ThingContract { /** * The exchange traded instrument associated with a Corporation object. The @@ -29,4 +31,926 @@ public function tickerSymbol($tickerSymbol) return $this->setProperty('tickerSymbol', $tickerSymbol); } + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Country.php b/src/Country.php index 3ef63bc68..67a2ad955 100644 --- a/src/Country.php +++ b/src/Country.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A country. * * @see http://schema.org/Country * - * @mixin \Spatie\SchemaOrg\AdministrativeArea */ -class Country extends BaseType +class Country extends BaseType implements AdministrativeAreaContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Course.php b/src/Course.php index 649341564..bce3cf9a6 100644 --- a/src/Course.php +++ b/src/Course.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A description of an educational course which may be offered as distinct * instances at which take place at different times or take place at different @@ -12,9 +15,8 @@ * * @see http://schema.org/Course * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Course extends BaseType +class Course extends BaseType implements CreativeWorkContract, ThingContract { /** * The identifier for the [[Course]] used by the course [[provider]] (e.g. @@ -63,4 +65,1509 @@ public function hasCourseInstance($hasCourseInstance) return $this->setProperty('hasCourseInstance', $hasCourseInstance); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CourseInstance.php b/src/CourseInstance.php index 835abfe92..7e9d84e8c 100644 --- a/src/CourseInstance.php +++ b/src/CourseInstance.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An instance of a [[Course]] which is distinct from other instances because it * is offered at a different time or location or through different media or @@ -9,9 +12,8 @@ * * @see http://schema.org/CourseInstance * - * @mixin \Spatie\SchemaOrg\Event */ -class CourseInstance extends BaseType +class CourseInstance extends BaseType implements EventContract, ThingContract { /** * The medium or means of delivery of the course instance or the mode of @@ -46,4 +48,715 @@ public function instructor($instructor) return $this->setProperty('instructor', $instructor); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Courthouse.php b/src/Courthouse.php index 6bbbcf933..8326010cd 100644 --- a/src/Courthouse.php +++ b/src/Courthouse.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A courthouse. * * @see http://schema.org/Courthouse * - * @mixin \Spatie\SchemaOrg\GovernmentBuilding */ -class Courthouse extends BaseType +class Courthouse extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CreateAction.php b/src/CreateAction.php index 4b1a0e8ef..3c8be13f1 100644 --- a/src/CreateAction.php +++ b/src/CreateAction.php @@ -2,14 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of deliberately creating/producing/generating/building a result out * of the agent. * * @see http://schema.org/CreateAction * - * @mixin \Spatie\SchemaOrg\Action */ -class CreateAction extends BaseType +class CreateAction extends BaseType implements ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CreativeWork.php b/src/CreativeWork.php index 0171251ed..b56aca418 100644 --- a/src/CreativeWork.php +++ b/src/CreativeWork.php @@ -2,15 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The most generic kind of creative work, including books, movies, photographs, * software programs, etc. * * @see http://schema.org/CreativeWork * - * @mixin \Spatie\SchemaOrg\Thing */ -class CreativeWork extends BaseType +class CreativeWork extends BaseType implements ThingContract { /** * The subject matter of the content. @@ -48,7 +49,7 @@ public function accessMode($accessMode) * understand all the intellectual content of a resource. Expected values * include: auditory, tactile, textual, visual. * - * @param string|string[] $accessModeSufficient + * @param ItemList|ItemList[] $accessModeSufficient * * @return static * @@ -1331,4 +1332,190 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CreativeWorkSeason.php b/src/CreativeWorkSeason.php index d0de9bca7..890bc6455 100644 --- a/src/CreativeWorkSeason.php +++ b/src/CreativeWorkSeason.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A media season e.g. tv, radio, video game etc. * * @see http://schema.org/CreativeWorkSeason * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class CreativeWorkSeason extends BaseType +class CreativeWorkSeason extends BaseType implements CreativeWorkContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -172,4 +174,1509 @@ public function trailer($trailer) return $this->setProperty('trailer', $trailer); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CreativeWorkSeries.php b/src/CreativeWorkSeries.php index a9b66fcfe..a8f210866 100644 --- a/src/CreativeWorkSeries.php +++ b/src/CreativeWorkSeries.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A CreativeWorkSeries in schema.org is a group of related items, typically but * not necessarily of the same kind. CreativeWorkSeries are usually organized @@ -23,10 +28,8 @@ * * @see http://schema.org/CreativeWorkSeries * - * @mixin \Spatie\SchemaOrg\CreativeWork - * @mixin \Spatie\SchemaOrg\Series */ -class CreativeWorkSeries extends BaseType +class CreativeWorkSeries extends BaseType implements CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { /** * The end date and time of the item (in [ISO 8601 date @@ -74,4 +77,1525 @@ public function startDate($startDate) return $this->setProperty('startDate', $startDate); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + } diff --git a/src/CreditCard.php b/src/CreditCard.php index c35f51c87..5e8b3c854 100644 --- a/src/CreditCard.php +++ b/src/CreditCard.php @@ -2,6 +2,13 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PaymentCardContract; +use \Spatie\SchemaOrg\Contracts\LoanOrCreditContract; +use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A card payment method of a particular brand or name. Used to mark up a * particular payment method and/or the financial product/service that supplies @@ -18,9 +25,621 @@ * * @see http://schema.org/CreditCard * - * @mixin \Spatie\SchemaOrg\PaymentCard - * @mixin \Spatie\SchemaOrg\LoanOrCredit */ -class CreditCard extends BaseType +class CreditCard extends BaseType implements PaymentCardContract, LoanOrCreditContract, FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * + * @return static + * + * @see http://schema.org/interestRate + */ + public function interestRate($interestRate) + { + return $this->setProperty('interestRate', $interestRate); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The amount of money. + * + * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount + * + * @return static + * + * @see http://schema.org/amount + */ + public function amount($amount) + { + return $this->setProperty('amount', $amount); + } + + /** + * The duration of the loan or credit agreement. + * + * @param QuantitativeValue|QuantitativeValue[] $loanTerm + * + * @return static + * + * @see http://schema.org/loanTerm + */ + public function loanTerm($loanTerm) + { + return $this->setProperty('loanTerm', $loanTerm); + } + + /** + * Assets required to secure loan or credit repayments. It may take form of + * third party pledge, goods, financial instruments (cash, securities, etc.) + * + * @param Thing|Thing[]|string|string[] $requiredCollateral + * + * @return static + * + * @see http://schema.org/requiredCollateral + */ + public function requiredCollateral($requiredCollateral) + { + return $this->setProperty('requiredCollateral', $requiredCollateral); + } + } diff --git a/src/Crematorium.php b/src/Crematorium.php index 853aee5ef..d44fed7c7 100644 --- a/src/Crematorium.php +++ b/src/Crematorium.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A crematorium. * * @see http://schema.org/Crematorium * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Crematorium extends BaseType +class Crematorium extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/CurrencyConversionService.php b/src/CurrencyConversionService.php index 082ad3d63..7c393f43d 100644 --- a/src/CurrencyConversionService.php +++ b/src/CurrencyConversionService.php @@ -2,13 +2,588 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A service to convert funds from one currency to another currency. * * @see http://schema.org/CurrencyConversionService * - * @mixin \Spatie\SchemaOrg\FinancialProduct */ -class CurrencyConversionService extends BaseType +class CurrencyConversionService extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * + * @return static + * + * @see http://schema.org/interestRate + */ + public function interestRate($interestRate) + { + return $this->setProperty('interestRate', $interestRate); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DanceEvent.php b/src/DanceEvent.php index c6fb3245a..bfbf4923d 100644 --- a/src/DanceEvent.php +++ b/src/DanceEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: A social dance. * * @see http://schema.org/DanceEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class DanceEvent extends BaseType +class DanceEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DanceGroup.php b/src/DanceGroup.php index 766db3f39..7f21e8cec 100644 --- a/src/DanceGroup.php +++ b/src/DanceGroup.php @@ -2,14 +2,939 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A dance group—for example, the Alvin Ailey Dance Theater or * Riverdance. * * @see http://schema.org/DanceGroup * - * @mixin \Spatie\SchemaOrg\PerformingGroup */ -class DanceGroup extends BaseType +class DanceGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DataCatalog.php b/src/DataCatalog.php index a61582398..eda13ac3a 100644 --- a/src/DataCatalog.php +++ b/src/DataCatalog.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A collection of datasets. * * @see http://schema.org/DataCatalog * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class DataCatalog extends BaseType +class DataCatalog extends BaseType implements CreativeWorkContract, ThingContract { /** * A dataset contained in this catalog. @@ -25,4 +27,1509 @@ public function dataset($dataset) return $this->setProperty('dataset', $dataset); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DataDownload.php b/src/DataDownload.php index cbd16c709..85d7bf5d7 100644 --- a/src/DataDownload.php +++ b/src/DataDownload.php @@ -2,13 +2,1772 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A dataset in downloadable form. * * @see http://schema.org/DataDownload * - * @mixin \Spatie\SchemaOrg\MediaObject */ -class DataDownload extends BaseType +class DataDownload extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Date when this media object was uploaded to this site. + * + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate + * + * @return static + * + * @see http://schema.org/uploadDate + */ + public function uploadDate($uploadDate) + { + return $this->setProperty('uploadDate', $uploadDate); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DataFeed.php b/src/DataFeed.php index b5fc08825..57cdd7870 100644 --- a/src/DataFeed.php +++ b/src/DataFeed.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\DatasetContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A single feed providing structured information about one or more entities or * topics. * * @see http://schema.org/DataFeed * - * @mixin \Spatie\SchemaOrg\Dataset */ -class DataFeed extends BaseType +class DataFeed extends BaseType implements DatasetContract, CreativeWorkContract, ThingContract { /** * An item within in a data feed. Data feeds may have many elements. @@ -26,4 +29,1598 @@ public function dataFeedElement($dataFeedElement) return $this->setProperty('dataFeedElement', $dataFeedElement); } + /** + * A data catalog which contains this dataset. + * + * @param DataCatalog|DataCatalog[] $catalog + * + * @return static + * + * @see http://schema.org/catalog + */ + public function catalog($catalog) + { + return $this->setProperty('catalog', $catalog); + } + + /** + * The range of temporal applicability of a dataset, e.g. for a 2011 census + * dataset, the year 2011 (in ISO 8601 time interval format). + * + * @param \DateTimeInterface|\DateTimeInterface[] $datasetTimeInterval + * + * @return static + * + * @see http://schema.org/datasetTimeInterval + */ + public function datasetTimeInterval($datasetTimeInterval) + { + return $this->setProperty('datasetTimeInterval', $datasetTimeInterval); + } + + /** + * A downloadable form of this dataset, at a specific location, in a + * specific format. + * + * @param DataDownload|DataDownload[] $distribution + * + * @return static + * + * @see http://schema.org/distribution + */ + public function distribution($distribution) + { + return $this->setProperty('distribution', $distribution); + } + + /** + * A data catalog which contains this dataset (this property was previously + * 'catalog', preferred name is now 'includedInDataCatalog'). + * + * @param DataCatalog|DataCatalog[] $includedDataCatalog + * + * @return static + * + * @see http://schema.org/includedDataCatalog + */ + public function includedDataCatalog($includedDataCatalog) + { + return $this->setProperty('includedDataCatalog', $includedDataCatalog); + } + + /** + * A data catalog which contains this dataset. + * + * @param DataCatalog|DataCatalog[] $includedInDataCatalog + * + * @return static + * + * @see http://schema.org/includedInDataCatalog + */ + public function includedInDataCatalog($includedInDataCatalog) + { + return $this->setProperty('includedInDataCatalog', $includedInDataCatalog); + } + + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DataFeedItem.php b/src/DataFeedItem.php index dc127e00a..e3c2a06c3 100644 --- a/src/DataFeedItem.php +++ b/src/DataFeedItem.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A single item within a larger data feed. * * @see http://schema.org/DataFeedItem * - * @mixin \Spatie\SchemaOrg\Intangible */ -class DataFeedItem extends BaseType +class DataFeedItem extends BaseType implements IntangibleContract, ThingContract { /** * The date on which the CreativeWork was created or the item was added to a @@ -70,4 +72,190 @@ public function item($item) return $this->setProperty('item', $item); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Dataset.php b/src/Dataset.php index 49aa11c84..42ac67821 100644 --- a/src/Dataset.php +++ b/src/Dataset.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A body of structured information describing some topic(s) of interest. * * @see http://schema.org/Dataset * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Dataset extends BaseType +class Dataset extends BaseType implements CreativeWorkContract, ThingContract { /** * A data catalog which contains this dataset. @@ -100,4 +102,1509 @@ public function issn($issn) return $this->setProperty('issn', $issn); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DatedMoneySpecification.php b/src/DatedMoneySpecification.php index 7882afe15..c7ee88bc3 100644 --- a/src/DatedMoneySpecification.php +++ b/src/DatedMoneySpecification.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A DatedMoneySpecification represents monetary values with optional start and * end dates. For example, this could represent an employee's salary over a @@ -10,9 +14,8 @@ * * @see http://schema.org/DatedMoneySpecification * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class DatedMoneySpecification extends BaseType +class DatedMoneySpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The amount of money. @@ -50,4 +53,190 @@ public function currency($currency) return $this->setProperty('currency', $currency); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DayOfWeek.php b/src/DayOfWeek.php index e42ce025d..4fe76b534 100644 --- a/src/DayOfWeek.php +++ b/src/DayOfWeek.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The day of the week, e.g. used to specify to which day the opening hours of * an OpeningHoursSpecification refer. @@ -13,9 +17,8 @@ * * @see http://schema.org/DayOfWeek * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class DayOfWeek extends BaseType +class DayOfWeek extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * The day of the week between Thursday and Saturday. @@ -79,4 +82,190 @@ class DayOfWeek extends BaseType */ const Wednesday = 'http://schema.org/Wednesday'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DaySpa.php b/src/DaySpa.php index bf48fcaf5..96bef7551 100644 --- a/src/DaySpa.php +++ b/src/DaySpa.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HealthAndBeautyBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A day spa. * * @see http://schema.org/DaySpa * - * @mixin \Spatie\SchemaOrg\HealthAndBeautyBusiness */ -class DaySpa extends BaseType +class DaySpa extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/DeactivateAction.php b/src/DeactivateAction.php index 251d422bd..f0b412196 100644 --- a/src/DeactivateAction.php +++ b/src/DeactivateAction.php @@ -2,14 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ControlActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of stopping or deactivating a device or application (e.g. stopping a * timer or turning off a flashlight). * * @see http://schema.org/DeactivateAction * - * @mixin \Spatie\SchemaOrg\ControlAction */ -class DeactivateAction extends BaseType +class DeactivateAction extends BaseType implements ControlActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DefenceEstablishment.php b/src/DefenceEstablishment.php index ab3ec7515..e3d31bce1 100644 --- a/src/DefenceEstablishment.php +++ b/src/DefenceEstablishment.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A defence establishment, such as an army or navy base. * * @see http://schema.org/DefenceEstablishment * - * @mixin \Spatie\SchemaOrg\GovernmentBuilding */ -class DefenceEstablishment extends BaseType +class DefenceEstablishment extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DeleteAction.php b/src/DeleteAction.php index a583c1376..ac3195b7e 100644 --- a/src/DeleteAction.php +++ b/src/DeleteAction.php @@ -2,13 +2,409 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of editing a recipient by removing one of its objects. * * @see http://schema.org/DeleteAction * - * @mixin \Spatie\SchemaOrg\UpdateAction */ -class DeleteAction extends BaseType +class DeleteAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract { + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $collection + * + * @return static + * + * @see http://schema.org/collection + */ + public function collection($collection) + { + return $this->setProperty('collection', $collection); + } + + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $targetCollection + * + * @return static + * + * @see http://schema.org/targetCollection + */ + public function targetCollection($targetCollection) + { + return $this->setProperty('targetCollection', $targetCollection); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DeliveryChargeSpecification.php b/src/DeliveryChargeSpecification.php index 404a7dde9..603fc6698 100644 --- a/src/DeliveryChargeSpecification.php +++ b/src/DeliveryChargeSpecification.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PriceSpecificationContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The price for the delivery of an offer using a particular delivery method. * * @see http://schema.org/DeliveryChargeSpecification * - * @mixin \Spatie\SchemaOrg\PriceSpecification */ -class DeliveryChargeSpecification extends BaseType +class DeliveryChargeSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract { /** * The delivery method(s) to which the delivery charge or payment charge @@ -77,4 +81,355 @@ public function ineligibleRegion($ineligibleRegion) return $this->setProperty('ineligibleRegion', $ineligibleRegion); } + /** + * The interval and unit of measurement of ordering quantities for which the + * offer or price specification is valid. This allows e.g. specifying that a + * certain freight charge is valid only for a certain quantity. + * + * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity + * + * @return static + * + * @see http://schema.org/eligibleQuantity + */ + public function eligibleQuantity($eligibleQuantity) + { + return $this->setProperty('eligibleQuantity', $eligibleQuantity); + } + + /** + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. + * + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * + * @return static + * + * @see http://schema.org/eligibleTransactionVolume + */ + public function eligibleTransactionVolume($eligibleTransactionVolume) + { + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + } + + /** + * The highest price if the price is a range. + * + * @param float|float[]|int|int[] $maxPrice + * + * @return static + * + * @see http://schema.org/maxPrice + */ + public function maxPrice($maxPrice) + { + return $this->setProperty('maxPrice', $maxPrice); + } + + /** + * The lowest price if the price is a range. + * + * @param float|float[]|int|int[] $minPrice + * + * @return static + * + * @see http://schema.org/minPrice + */ + public function minPrice($minPrice) + { + return $this->setProperty('minPrice', $minPrice); + } + + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * + * @return static + * + * @see http://schema.org/validThrough + */ + public function validThrough($validThrough) + { + return $this->setProperty('validThrough', $validThrough); + } + + /** + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. + * + * @param bool|bool[] $valueAddedTaxIncluded + * + * @return static + * + * @see http://schema.org/valueAddedTaxIncluded + */ + public function valueAddedTaxIncluded($valueAddedTaxIncluded) + { + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DeliveryEvent.php b/src/DeliveryEvent.php index 6d94085d8..ddc8ae33d 100644 --- a/src/DeliveryEvent.php +++ b/src/DeliveryEvent.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An event involving the delivery of an item. * * @see http://schema.org/DeliveryEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class DeliveryEvent extends BaseType +class DeliveryEvent extends BaseType implements EventContract, ThingContract { /** * Password, PIN, or access code needed for delivery (e.g. from a locker). @@ -67,4 +69,715 @@ public function hasDeliveryMethod($hasDeliveryMethod) return $this->setProperty('hasDeliveryMethod', $hasDeliveryMethod); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DeliveryMethod.php b/src/DeliveryMethod.php index d5ca4308f..938a2adc3 100644 --- a/src/DeliveryMethod.php +++ b/src/DeliveryMethod.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A delivery method is a standardized procedure for transferring the product or * service to the destination of fulfillment chosen by the customer. Delivery @@ -22,9 +26,8 @@ * * @see http://schema.org/DeliveryMethod * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class DeliveryMethod extends BaseType +class DeliveryMethod extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * A DeliveryMethod in which an item is collected on site, e.g. in a store @@ -34,4 +37,190 @@ class DeliveryMethod extends BaseType */ const OnSitePickup = 'http://schema.org/OnSitePickup'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Demand.php b/src/Demand.php index 07caf8df1..3aa174ae0 100644 --- a/src/Demand.php +++ b/src/Demand.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A demand entity represents the public, not necessarily binding, not * necessarily exclusive, announcement by an organization or person to seek a @@ -10,9 +13,8 @@ * * @see http://schema.org/Demand * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Demand extends BaseType +class Demand extends BaseType implements IntangibleContract, ThingContract { /** * The payment method(s) accepted by seller for this offer. @@ -511,4 +513,190 @@ public function warranty($warranty) return $this->setProperty('warranty', $warranty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Dentist.php b/src/Dentist.php index e275dca03..29dc8c94f 100644 --- a/src/Dentist.php +++ b/src/Dentist.php @@ -2,14 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A dentist. * * @see http://schema.org/Dentist * - * @mixin \Spatie\SchemaOrg\MedicalOrganization - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class Dentist extends BaseType +class Dentist extends BaseType implements MedicalOrganizationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/DepartAction.php b/src/DepartAction.php index 97214c3dc..e5be5aa9c 100644 --- a/src/DepartAction.php +++ b/src/DepartAction.php @@ -2,14 +2,412 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MoveActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of departing from a place. An agent departs from an fromLocation for * a destination, optionally with participants. * * @see http://schema.org/DepartAction * - * @mixin \Spatie\SchemaOrg\MoveAction */ -class DepartAction extends BaseType +class DepartAction extends BaseType implements MoveActionContract, ActionContract, ThingContract { + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DepartmentStore.php b/src/DepartmentStore.php index 862318524..2f1a7996b 100644 --- a/src/DepartmentStore.php +++ b/src/DepartmentStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A department store. * * @see http://schema.org/DepartmentStore * - * @mixin \Spatie\SchemaOrg\Store */ -class DepartmentStore extends BaseType +class DepartmentStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/DepositAccount.php b/src/DepositAccount.php index 642fd373e..b566a933c 100644 --- a/src/DepositAccount.php +++ b/src/DepositAccount.php @@ -2,15 +2,605 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BankAccountContract; +use \Spatie\SchemaOrg\Contracts\InvestmentOrDepositContract; +use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A type of Bank Account with a main purpose of depositing funds to gain * interest or other benefits. * * @see http://schema.org/DepositAccount * - * @mixin \Spatie\SchemaOrg\BankAccount - * @mixin \Spatie\SchemaOrg\InvestmentOrDeposit */ -class DepositAccount extends BaseType +class DepositAccount extends BaseType implements BankAccountContract, InvestmentOrDepositContract, FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * + * @return static + * + * @see http://schema.org/interestRate + */ + public function interestRate($interestRate) + { + return $this->setProperty('interestRate', $interestRate); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The amount of money. + * + * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount + * + * @return static + * + * @see http://schema.org/amount + */ + public function amount($amount) + { + return $this->setProperty('amount', $amount); + } + } diff --git a/src/DigitalDocument.php b/src/DigitalDocument.php index b88120d7e..aa7bc0152 100644 --- a/src/DigitalDocument.php +++ b/src/DigitalDocument.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An electronic file or document. * * @see http://schema.org/DigitalDocument * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class DigitalDocument extends BaseType +class DigitalDocument extends BaseType implements CreativeWorkContract, ThingContract { /** * A permission related to the access to this document (e.g. permission to @@ -27,4 +29,1509 @@ public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DigitalDocumentPermission.php b/src/DigitalDocumentPermission.php index b586cedec..55cdb4115 100644 --- a/src/DigitalDocumentPermission.php +++ b/src/DigitalDocumentPermission.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A permission for a particular person or group to access a particular file. * * @see http://schema.org/DigitalDocumentPermission * - * @mixin \Spatie\SchemaOrg\Intangible */ -class DigitalDocumentPermission extends BaseType +class DigitalDocumentPermission extends BaseType implements IntangibleContract, ThingContract { /** * The person, organization, contact point, or audience that has been @@ -40,4 +42,190 @@ public function permissionType($permissionType) return $this->setProperty('permissionType', $permissionType); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DigitalDocumentPermissionType.php b/src/DigitalDocumentPermissionType.php index db3e47fd6..ed6bf4ea0 100644 --- a/src/DigitalDocumentPermissionType.php +++ b/src/DigitalDocumentPermissionType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A type of permission which can be granted for accessing a digital document. * * @see http://schema.org/DigitalDocumentPermissionType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class DigitalDocumentPermissionType extends BaseType +class DigitalDocumentPermissionType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * Permission to add comments to the document. @@ -32,4 +35,190 @@ class DigitalDocumentPermissionType extends BaseType */ const WritePermission = 'http://schema.org/WritePermission'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DisagreeAction.php b/src/DisagreeAction.php index 27fd59935..3e790b830 100644 --- a/src/DisagreeAction.php +++ b/src/DisagreeAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of expressing a difference of opinion with the object. An agent * disagrees to/about an object (a proposition, topic or theme) with @@ -9,8 +14,372 @@ * * @see http://schema.org/DisagreeAction * - * @mixin \Spatie\SchemaOrg\ReactAction */ -class DisagreeAction extends BaseType +class DisagreeAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DiscoverAction.php b/src/DiscoverAction.php index 04f250c87..8fb6b7a0e 100644 --- a/src/DiscoverAction.php +++ b/src/DiscoverAction.php @@ -2,13 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FindActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of discovering/finding an object. * * @see http://schema.org/DiscoverAction * - * @mixin \Spatie\SchemaOrg\FindAction */ -class DiscoverAction extends BaseType +class DiscoverAction extends BaseType implements FindActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DiscussionForumPosting.php b/src/DiscussionForumPosting.php index 949dbf203..be7a60882 100644 --- a/src/DiscussionForumPosting.php +++ b/src/DiscussionForumPosting.php @@ -2,13 +2,1662 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A posting to a discussion forum. * * @see http://schema.org/DiscussionForumPosting * - * @mixin \Spatie\SchemaOrg\SocialMediaPosting */ -class DiscussionForumPosting extends BaseType +class DiscussionForumPosting extends BaseType implements SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract { + /** + * A CreativeWork such as an image, video, or audio clip shared as part of + * this posting. + * + * @param CreativeWork|CreativeWork[] $sharedContent + * + * @return static + * + * @see http://schema.org/sharedContent + */ + public function sharedContent($sharedContent) + { + return $this->setProperty('sharedContent', $sharedContent); + } + + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DislikeAction.php b/src/DislikeAction.php index 227cb8a84..2b7b61d03 100644 --- a/src/DislikeAction.php +++ b/src/DislikeAction.php @@ -2,14 +2,383 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of expressing a negative sentiment about the object. An agent * dislikes an object (a proposition, topic or theme) with participants. * * @see http://schema.org/DislikeAction * - * @mixin \Spatie\SchemaOrg\ReactAction */ -class DislikeAction extends BaseType +class DislikeAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Distance.php b/src/Distance.php index bdc295b6b..504e48189 100644 --- a/src/Distance.php +++ b/src/Distance.php @@ -2,14 +2,203 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\QuantityContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Properties that take Distances as values are of the form '<Number> * <Length unit of measure>'. E.g., '7 ft'. * * @see http://schema.org/Distance * - * @mixin \Spatie\SchemaOrg\Quantity */ -class Distance extends BaseType +class Distance extends BaseType implements QuantityContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Distillery.php b/src/Distillery.php index c9de2208a..ab5789073 100644 --- a/src/Distillery.php +++ b/src/Distillery.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A distillery. * * @see http://schema.org/Distillery * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class Distillery extends BaseType +class Distillery extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/DonateAction.php b/src/DonateAction.php index 289fd886d..e747d19f2 100644 --- a/src/DonateAction.php +++ b/src/DonateAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of providing goods, services, or money without compensation, often * for philanthropic reasons. * * @see http://schema.org/DonateAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class DonateAction extends BaseType +class DonateAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** * A sub property of participant. The participant who is at the receiving @@ -27,4 +30,444 @@ public function recipient($recipient) return $this->setProperty('recipient', $recipient); } + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DownloadAction.php b/src/DownloadAction.php index ffb55318d..2044cbf07 100644 --- a/src/DownloadAction.php +++ b/src/DownloadAction.php @@ -2,13 +2,411 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of downloading an object. * * @see http://schema.org/DownloadAction * - * @mixin \Spatie\SchemaOrg\TransferAction */ -class DownloadAction extends BaseType +class DownloadAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DrawAction.php b/src/DrawAction.php index 30fa68af6..6651805f8 100644 --- a/src/DrawAction.php +++ b/src/DrawAction.php @@ -2,14 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of producing a visual/graphical representation of an object, * typically with a pen/pencil and paper as instruments. * * @see http://schema.org/DrawAction * - * @mixin \Spatie\SchemaOrg\CreateAction */ -class DrawAction extends BaseType +class DrawAction extends BaseType implements CreateActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DrinkAction.php b/src/DrinkAction.php index 8f9635d01..f6907d6fe 100644 --- a/src/DrinkAction.php +++ b/src/DrinkAction.php @@ -2,13 +2,413 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of swallowing liquids. * * @see http://schema.org/DrinkAction * - * @mixin \Spatie\SchemaOrg\ConsumeAction */ -class DrinkAction extends BaseType +class DrinkAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DriveWheelConfigurationValue.php b/src/DriveWheelConfigurationValue.php index 7a9a9b07a..72d3540d5 100644 --- a/src/DriveWheelConfigurationValue.php +++ b/src/DriveWheelConfigurationValue.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A value indicating which roadwheels will receive torque. * * @see http://schema.org/DriveWheelConfigurationValue * - * @mixin \Spatie\SchemaOrg\QualitativeValue */ -class DriveWheelConfigurationValue extends BaseType +class DriveWheelConfigurationValue extends BaseType implements QualitativeValueContract, EnumerationContract, IntangibleContract, ThingContract { /** * All-wheel Drive is a transmission layout where the engine drives all four @@ -43,4 +47,317 @@ class DriveWheelConfigurationValue extends BaseType */ const RearWheelDriveConfiguration = 'http://schema.org/RearWheelDriveConfiguration'; + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $equal + * + * @return static + * + * @see http://schema.org/equal + */ + public function equal($equal) + { + return $this->setProperty('equal', $equal); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is greater than the object. + * + * @param QualitativeValue|QualitativeValue[] $greater + * + * @return static + * + * @see http://schema.org/greater + */ + public function greater($greater) + { + return $this->setProperty('greater', $greater); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is greater than or equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $greaterOrEqual + * + * @return static + * + * @see http://schema.org/greaterOrEqual + */ + public function greaterOrEqual($greaterOrEqual) + { + return $this->setProperty('greaterOrEqual', $greaterOrEqual); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is lesser than the object. + * + * @param QualitativeValue|QualitativeValue[] $lesser + * + * @return static + * + * @see http://schema.org/lesser + */ + public function lesser($lesser) + { + return $this->setProperty('lesser', $lesser); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is lesser than or equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $lesserOrEqual + * + * @return static + * + * @see http://schema.org/lesserOrEqual + */ + public function lesserOrEqual($lesserOrEqual) + { + return $this->setProperty('lesserOrEqual', $lesserOrEqual); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is not equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $nonEqual + * + * @return static + * + * @see http://schema.org/nonEqual + */ + public function nonEqual($nonEqual) + { + return $this->setProperty('nonEqual', $nonEqual); + } + + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/DryCleaningOrLaundry.php b/src/DryCleaningOrLaundry.php index 2260b18d7..7436d4107 100644 --- a/src/DryCleaningOrLaundry.php +++ b/src/DryCleaningOrLaundry.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A dry-cleaning business. * * @see http://schema.org/DryCleaningOrLaundry * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class DryCleaningOrLaundry extends BaseType +class DryCleaningOrLaundry extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Duration.php b/src/Duration.php index 505734238..8b325e16a 100644 --- a/src/Duration.php +++ b/src/Duration.php @@ -2,14 +2,203 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\QuantityContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Quantity: Duration (use [ISO 8601 duration * format](http://en.wikipedia.org/wiki/ISO_8601)). * * @see http://schema.org/Duration * - * @mixin \Spatie\SchemaOrg\Quantity */ -class Duration extends BaseType +class Duration extends BaseType implements QuantityContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EatAction.php b/src/EatAction.php index 5a59e5581..4971c9d8e 100644 --- a/src/EatAction.php +++ b/src/EatAction.php @@ -2,13 +2,413 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of swallowing solid objects. * * @see http://schema.org/EatAction * - * @mixin \Spatie\SchemaOrg\ConsumeAction */ -class EatAction extends BaseType +class EatAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EducationEvent.php b/src/EducationEvent.php index eced36e6d..b883c89e1 100644 --- a/src/EducationEvent.php +++ b/src/EducationEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Education event. * * @see http://schema.org/EducationEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class EducationEvent extends BaseType +class EducationEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EducationalAudience.php b/src/EducationalAudience.php index 7f43ac79e..627eab8d5 100644 --- a/src/EducationalAudience.php +++ b/src/EducationalAudience.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AudienceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An EducationalAudience. * * @see http://schema.org/EducationalAudience * - * @mixin \Spatie\SchemaOrg\Audience */ -class EducationalAudience extends BaseType +class EducationalAudience extends BaseType implements AudienceContract, IntangibleContract, ThingContract { /** * An educationalRole of an EducationalAudience. @@ -25,4 +28,219 @@ public function educationalRole($educationalRole) return $this->setProperty('educationalRole', $educationalRole); } + /** + * The target group associated with a given audience (e.g. veterans, car + * owners, musicians, etc.). + * + * @param string|string[] $audienceType + * + * @return static + * + * @see http://schema.org/audienceType + */ + public function audienceType($audienceType) + { + return $this->setProperty('audienceType', $audienceType); + } + + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EducationalOrganization.php b/src/EducationalOrganization.php index 7b2d9d7fc..3d7fa2d72 100644 --- a/src/EducationalOrganization.php +++ b/src/EducationalOrganization.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An educational organization. * * @see http://schema.org/EducationalOrganization * - * @mixin \Spatie\SchemaOrg\Organization */ -class EducationalOrganization extends BaseType +class EducationalOrganization extends BaseType implements OrganizationContract, ThingContract { /** * Alumni of an organization. @@ -25,4 +27,926 @@ public function alumni($alumni) return $this->setProperty('alumni', $alumni); } + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Electrician.php b/src/Electrician.php index 8ea43b8b3..ae315c1c2 100644 --- a/src/Electrician.php +++ b/src/Electrician.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HomeAndConstructionBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An electrician. * * @see http://schema.org/Electrician * - * @mixin \Spatie\SchemaOrg\HomeAndConstructionBusiness */ -class Electrician extends BaseType +class Electrician extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ElectronicsStore.php b/src/ElectronicsStore.php index 6239e74d1..2679f088c 100644 --- a/src/ElectronicsStore.php +++ b/src/ElectronicsStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An electronics store. * * @see http://schema.org/ElectronicsStore * - * @mixin \Spatie\SchemaOrg\Store */ -class ElectronicsStore extends BaseType +class ElectronicsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ElementarySchool.php b/src/ElementarySchool.php index e044454d9..733833b20 100644 --- a/src/ElementarySchool.php +++ b/src/ElementarySchool.php @@ -2,13 +2,952 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EducationalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An elementary school. * * @see http://schema.org/ElementarySchool * - * @mixin \Spatie\SchemaOrg\EducationalOrganization */ -class ElementarySchool extends BaseType +class ElementarySchool extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EmailMessage.php b/src/EmailMessage.php index 961c2d3fc..5c88d4e1e 100644 --- a/src/EmailMessage.php +++ b/src/EmailMessage.php @@ -2,13 +2,1651 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MessageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An email message. * * @see http://schema.org/EmailMessage * - * @mixin \Spatie\SchemaOrg\Message */ -class EmailMessage extends BaseType +class EmailMessage extends BaseType implements MessageContract, CreativeWorkContract, ThingContract { + /** + * A sub property of recipient. The recipient blind copied on a message. + * + * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $bccRecipient + * + * @return static + * + * @see http://schema.org/bccRecipient + */ + public function bccRecipient($bccRecipient) + { + return $this->setProperty('bccRecipient', $bccRecipient); + } + + /** + * A sub property of recipient. The recipient copied on a message. + * + * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $ccRecipient + * + * @return static + * + * @see http://schema.org/ccRecipient + */ + public function ccRecipient($ccRecipient) + { + return $this->setProperty('ccRecipient', $ccRecipient); + } + + /** + * The date/time at which the message has been read by the recipient if a + * single recipient exists. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateRead + * + * @return static + * + * @see http://schema.org/dateRead + */ + public function dateRead($dateRead) + { + return $this->setProperty('dateRead', $dateRead); + } + + /** + * The date/time the message was received if a single recipient exists. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateReceived + * + * @return static + * + * @see http://schema.org/dateReceived + */ + public function dateReceived($dateReceived) + { + return $this->setProperty('dateReceived', $dateReceived); + } + + /** + * The date/time at which the message was sent. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateSent + * + * @return static + * + * @see http://schema.org/dateSent + */ + public function dateSent($dateSent) + { + return $this->setProperty('dateSent', $dateSent); + } + + /** + * A CreativeWork attached to the message. + * + * @param CreativeWork|CreativeWork[] $messageAttachment + * + * @return static + * + * @see http://schema.org/messageAttachment + */ + public function messageAttachment($messageAttachment) + { + return $this->setProperty('messageAttachment', $messageAttachment); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * A sub property of participant. The participant who is at the sending end + * of the action. + * + * @param Audience|Audience[]|Organization|Organization[]|Person|Person[] $sender + * + * @return static + * + * @see http://schema.org/sender + */ + public function sender($sender) + { + return $this->setProperty('sender', $sender); + } + + /** + * A sub property of recipient. The recipient who was directly sent the + * message. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $toRecipient + * + * @return static + * + * @see http://schema.org/toRecipient + */ + public function toRecipient($toRecipient) + { + return $this->setProperty('toRecipient', $toRecipient); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Embassy.php b/src/Embassy.php index 5b278bc49..3e993ae7e 100644 --- a/src/Embassy.php +++ b/src/Embassy.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An embassy. * * @see http://schema.org/Embassy * - * @mixin \Spatie\SchemaOrg\GovernmentBuilding */ -class Embassy extends BaseType +class Embassy extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EmergencyService.php b/src/EmergencyService.php index e8cf85dff..720167290 100644 --- a/src/EmergencyService.php +++ b/src/EmergencyService.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An emergency service, such as a fire station or ER. * * @see http://schema.org/EmergencyService * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class EmergencyService extends BaseType +class EmergencyService extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/EmployeeRole.php b/src/EmployeeRole.php index a2eec40e0..fddf298df 100644 --- a/src/EmployeeRole.php +++ b/src/EmployeeRole.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationRoleContract; +use \Spatie\SchemaOrg\Contracts\RoleContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A subclass of OrganizationRole used to describe employee relationships. * * @see http://schema.org/EmployeeRole * - * @mixin \Spatie\SchemaOrg\OrganizationRole */ -class EmployeeRole extends BaseType +class EmployeeRole extends BaseType implements OrganizationRoleContract, RoleContract, IntangibleContract, ThingContract { /** * The base salary of the job or of an employee in an EmployeeRole. @@ -41,4 +45,268 @@ public function salaryCurrency($salaryCurrency) return $this->setProperty('salaryCurrency', $salaryCurrency); } + /** + * A number associated with a role in an organization, for example, the + * number on an athlete's jersey. + * + * @param float|float[]|int|int[] $numberedPosition + * + * @return static + * + * @see http://schema.org/numberedPosition + */ + public function numberedPosition($numberedPosition) + { + return $this->setProperty('numberedPosition', $numberedPosition); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * A position played, performed or filled by a person or organization, as + * part of an organization. For example, an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $namedPosition + * + * @return static + * + * @see http://schema.org/namedPosition + */ + public function namedPosition($namedPosition) + { + return $this->setProperty('namedPosition', $namedPosition); + } + + /** + * A role played, performed or filled by a person or organization. For + * example, the team of creators for a comic book might fill the roles named + * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $roleName + * + * @return static + * + * @see http://schema.org/roleName + */ + public function roleName($roleName) + { + return $this->setProperty('roleName', $roleName); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EmployerAggregateRating.php b/src/EmployerAggregateRating.php index 9767b37a9..1341ac029 100644 --- a/src/EmployerAggregateRating.php +++ b/src/EmployerAggregateRating.php @@ -2,13 +2,327 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AggregateRatingContract; +use \Spatie\SchemaOrg\Contracts\RatingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An aggregate rating of an Organization related to its role as an employer. * * @see http://schema.org/EmployerAggregateRating * - * @mixin \Spatie\SchemaOrg\AggregateRating */ -class EmployerAggregateRating extends BaseType +class EmployerAggregateRating extends BaseType implements AggregateRatingContract, RatingContract, IntangibleContract, ThingContract { + /** + * The item that is being reviewed/rated. + * + * @param Thing|Thing[] $itemReviewed + * + * @return static + * + * @see http://schema.org/itemReviewed + */ + public function itemReviewed($itemReviewed) + { + return $this->setProperty('itemReviewed', $itemReviewed); + } + + /** + * The count of total number of ratings. + * + * @param int|int[] $ratingCount + * + * @return static + * + * @see http://schema.org/ratingCount + */ + public function ratingCount($ratingCount) + { + return $this->setProperty('ratingCount', $ratingCount); + } + + /** + * The count of total number of reviews. + * + * @param int|int[] $reviewCount + * + * @return static + * + * @see http://schema.org/reviewCount + */ + public function reviewCount($reviewCount) + { + return $this->setProperty('reviewCount', $reviewCount); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * The highest value allowed in this rating system. If bestRating is + * omitted, 5 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $bestRating + * + * @return static + * + * @see http://schema.org/bestRating + */ + public function bestRating($bestRating) + { + return $this->setProperty('bestRating', $bestRating); + } + + /** + * The rating for the content. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $ratingValue + * + * @return static + * + * @see http://schema.org/ratingValue + */ + public function ratingValue($ratingValue) + { + return $this->setProperty('ratingValue', $ratingValue); + } + + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + + /** + * The lowest value allowed in this rating system. If worstRating is + * omitted, 1 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $worstRating + * + * @return static + * + * @see http://schema.org/worstRating + */ + public function worstRating($worstRating) + { + return $this->setProperty('worstRating', $worstRating); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EmploymentAgency.php b/src/EmploymentAgency.php index 661ba424f..8397231e6 100644 --- a/src/EmploymentAgency.php +++ b/src/EmploymentAgency.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An employment agency. * * @see http://schema.org/EmploymentAgency * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class EmploymentAgency extends BaseType +class EmploymentAgency extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/EndorseAction.php b/src/EndorseAction.php index ecb2bf1cf..c13ab940a 100644 --- a/src/EndorseAction.php +++ b/src/EndorseAction.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent approves/certifies/likes/supports/sanction an object. * * @see http://schema.org/EndorseAction * - * @mixin \Spatie\SchemaOrg\ReactAction */ -class EndorseAction extends BaseType +class EndorseAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract { /** * A sub property of participant. The person/organization being supported. @@ -25,4 +29,369 @@ public function endorsee($endorsee) return $this->setProperty('endorsee', $endorsee); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EndorsementRating.php b/src/EndorsementRating.php index e5bd74396..c0b5c4737 100644 --- a/src/EndorsementRating.php +++ b/src/EndorsementRating.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\RatingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An EndorsementRating is a rating that expresses some level of endorsement, * for example inclusion in a "critic's pick" blog, a @@ -19,8 +23,275 @@ * * @see http://schema.org/EndorsementRating * - * @mixin \Spatie\SchemaOrg\Rating */ -class EndorsementRating extends BaseType +class EndorsementRating extends BaseType implements RatingContract, IntangibleContract, ThingContract { + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * The highest value allowed in this rating system. If bestRating is + * omitted, 5 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $bestRating + * + * @return static + * + * @see http://schema.org/bestRating + */ + public function bestRating($bestRating) + { + return $this->setProperty('bestRating', $bestRating); + } + + /** + * The rating for the content. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $ratingValue + * + * @return static + * + * @see http://schema.org/ratingValue + */ + public function ratingValue($ratingValue) + { + return $this->setProperty('ratingValue', $ratingValue); + } + + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + + /** + * The lowest value allowed in this rating system. If worstRating is + * omitted, 1 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $worstRating + * + * @return static + * + * @see http://schema.org/worstRating + */ + public function worstRating($worstRating) + { + return $this->setProperty('worstRating', $worstRating); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Energy.php b/src/Energy.php index f849eb27e..a3d1d764e 100644 --- a/src/Energy.php +++ b/src/Energy.php @@ -2,14 +2,203 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\QuantityContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Properties that take Energy as values are of the form '<Number> * <Energy unit of measure>'. * * @see http://schema.org/Energy * - * @mixin \Spatie\SchemaOrg\Quantity */ -class Energy extends BaseType +class Energy extends BaseType implements QuantityContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EngineSpecification.php b/src/EngineSpecification.php index 82bed9e95..53c23a01d 100644 --- a/src/EngineSpecification.php +++ b/src/EngineSpecification.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Information about the engine of the vehicle. A vehicle can have multiple * engines represented by multiple engine specification entities. * * @see http://schema.org/EngineSpecification * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class EngineSpecification extends BaseType +class EngineSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The type of fuel suitable for the engine or engines of the vehicle. If @@ -28,4 +31,190 @@ public function fuelType($fuelType) return $this->setProperty('fuelType', $fuelType); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EntertainmentBusiness.php b/src/EntertainmentBusiness.php index 1ef98df22..80e153e57 100644 --- a/src/EntertainmentBusiness.php +++ b/src/EntertainmentBusiness.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A business providing entertainment. * * @see http://schema.org/EntertainmentBusiness * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class EntertainmentBusiness extends BaseType +class EntertainmentBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/EntryPoint.php b/src/EntryPoint.php index d1f5fd835..fd289ce64 100644 --- a/src/EntryPoint.php +++ b/src/EntryPoint.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An entry point, within some Web-based protocol. * * @see http://schema.org/EntryPoint * - * @mixin \Spatie\SchemaOrg\Intangible */ -class EntryPoint extends BaseType +class EntryPoint extends BaseType implements IntangibleContract, ThingContract { /** * An application that can complete the request. @@ -113,4 +115,190 @@ public function urlTemplate($urlTemplate) return $this->setProperty('urlTemplate', $urlTemplate); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Enumeration.php b/src/Enumeration.php index 2151b0586..1f8c86620 100644 --- a/src/Enumeration.php +++ b/src/Enumeration.php @@ -2,13 +2,201 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Lists or enumerations—for example, a list of cuisines or music genres, etc. * * @see http://schema.org/Enumeration * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Enumeration extends BaseType +class Enumeration extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Episode.php b/src/Episode.php index fcc455f13..815eda84c 100644 --- a/src/Episode.php +++ b/src/Episode.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A media episode (e.g. TV, radio, video game) which can be part of a series or * season. * * @see http://schema.org/Episode * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Episode extends BaseType +class Episode extends BaseType implements CreativeWorkContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -159,4 +161,1509 @@ public function trailer($trailer) return $this->setProperty('trailer', $trailer); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Event.php b/src/Event.php index 5ce811d4a..15429d59b 100644 --- a/src/Event.php +++ b/src/Event.php @@ -2,6 +2,8 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An event happening at a certain time and location, such as a concert, * lecture, or festival. Ticketing information may be added via the [[offers]] @@ -9,9 +11,8 @@ * * @see http://schema.org/Event * - * @mixin \Spatie\SchemaOrg\Thing */ -class Event extends BaseType +class Event extends BaseType implements ThingContract { /** * The subject matter of the content. @@ -538,4 +539,190 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EventReservation.php b/src/EventReservation.php index 13ec2463a..552397aa0 100644 --- a/src/EventReservation.php +++ b/src/EventReservation.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservation for an event like a concert, sporting event, or lecture. * @@ -11,8 +15,399 @@ * * @see http://schema.org/EventReservation * - * @mixin \Spatie\SchemaOrg\Reservation */ -class EventReservation extends BaseType +class EventReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EventStatusType.php b/src/EventStatusType.php index e38d8de77..d1c7a467a 100644 --- a/src/EventStatusType.php +++ b/src/EventStatusType.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * EventStatusType is an enumeration type whose instances represent several * states that an Event may be in. * * @see http://schema.org/EventStatusType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class EventStatusType extends BaseType +class EventStatusType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * The event has been cancelled. If the event has multiple startDate values, @@ -47,4 +50,190 @@ class EventStatusType extends BaseType */ const EventScheduled = 'http://schema.org/EventScheduled'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/EventVenue.php b/src/EventVenue.php index b8d00d3c9..27970fd4e 100644 --- a/src/EventVenue.php +++ b/src/EventVenue.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An event venue. * * @see http://schema.org/EventVenue * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class EventVenue extends BaseType +class EventVenue extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ExerciseAction.php b/src/ExerciseAction.php index f0efd3e6a..cfbee6b83 100644 --- a/src/ExerciseAction.php +++ b/src/ExerciseAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlayActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of participating in exertive activity for the purposes of improving * health and fitness. * * @see http://schema.org/ExerciseAction * - * @mixin \Spatie\SchemaOrg\PlayAction */ -class ExerciseAction extends BaseType +class ExerciseAction extends BaseType implements PlayActionContract, ActionContract, ThingContract { /** * A sub property of location. The course where this action was taken. @@ -142,4 +145,398 @@ public function toLocation($toLocation) return $this->setProperty('toLocation', $toLocation); } + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ExerciseGym.php b/src/ExerciseGym.php index ab5fac9af..b9162462a 100644 --- a/src/ExerciseGym.php +++ b/src/ExerciseGym.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A gym. * * @see http://schema.org/ExerciseGym * - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class ExerciseGym extends BaseType +class ExerciseGym extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ExhibitionEvent.php b/src/ExhibitionEvent.php index c5ec619d0..be28c0e07 100644 --- a/src/ExhibitionEvent.php +++ b/src/ExhibitionEvent.php @@ -2,14 +2,727 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Exhibition event, e.g. at a museum, library, archive, tradeshow, * ... * * @see http://schema.org/ExhibitionEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class ExhibitionEvent extends BaseType +class ExhibitionEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FAQPage.php b/src/FAQPage.php index 2bd9b9473..cbaace087 100644 --- a/src/FAQPage.php +++ b/src/FAQPage.php @@ -2,14 +2,1692 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A [[FAQPage]] is a [[WebPage]] presenting one or more "[Frequently asked * questions](https://en.wikipedia.org/wiki/FAQ)" (see also [[QAPage]]). * * @see http://schema.org/FAQPage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class FAQPage extends BaseType +class FAQPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FMRadioChannel.php b/src/FMRadioChannel.php index aff6de9bf..fc961bb61 100644 --- a/src/FMRadioChannel.php +++ b/src/FMRadioChannel.php @@ -2,13 +2,291 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\RadioChannelContract; +use \Spatie\SchemaOrg\Contracts\BroadcastChannelContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A radio channel that uses FM. * * @see http://schema.org/FMRadioChannel * - * @mixin \Spatie\SchemaOrg\RadioChannel */ -class FMRadioChannel extends BaseType +class FMRadioChannel extends BaseType implements RadioChannelContract, BroadcastChannelContract, IntangibleContract, ThingContract { + /** + * The unique address by which the BroadcastService can be identified in a + * provider lineup. In US, this is typically a number. + * + * @param string|string[] $broadcastChannelId + * + * @return static + * + * @see http://schema.org/broadcastChannelId + */ + public function broadcastChannelId($broadcastChannelId) + { + return $this->setProperty('broadcastChannelId', $broadcastChannelId); + } + + /** + * The frequency used for over-the-air broadcasts. Numeric values or simple + * ranges e.g. 87-99. In addition a shortcut idiom is supported for + * frequences of AM and FM radio channels, e.g. "87 FM". + * + * @param BroadcastFrequencySpecification|BroadcastFrequencySpecification[]|string|string[] $broadcastFrequency + * + * @return static + * + * @see http://schema.org/broadcastFrequency + */ + public function broadcastFrequency($broadcastFrequency) + { + return $this->setProperty('broadcastFrequency', $broadcastFrequency); + } + + /** + * The type of service required to have access to the channel (e.g. Standard + * or Premium). + * + * @param string|string[] $broadcastServiceTier + * + * @return static + * + * @see http://schema.org/broadcastServiceTier + */ + public function broadcastServiceTier($broadcastServiceTier) + { + return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FastFoodRestaurant.php b/src/FastFoodRestaurant.php index 898ad5190..d5c37a75c 100644 --- a/src/FastFoodRestaurant.php +++ b/src/FastFoodRestaurant.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A fast-food restaurant. * * @see http://schema.org/FastFoodRestaurant * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class FastFoodRestaurant extends BaseType +class FastFoodRestaurant extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Festival.php b/src/Festival.php index eb2979d9f..a9065bf18 100644 --- a/src/Festival.php +++ b/src/Festival.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Festival. * * @see http://schema.org/Festival * - * @mixin \Spatie\SchemaOrg\Event */ -class Festival extends BaseType +class Festival extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FilmAction.php b/src/FilmAction.php index 40e1ab55f..3d4c24d84 100644 --- a/src/FilmAction.php +++ b/src/FilmAction.php @@ -2,13 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of capturing sound and moving images on film, video, or digitally. * * @see http://schema.org/FilmAction * - * @mixin \Spatie\SchemaOrg\CreateAction */ -class FilmAction extends BaseType +class FilmAction extends BaseType implements CreateActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FinancialProduct.php b/src/FinancialProduct.php index f281815af..2cb9c1e6c 100644 --- a/src/FinancialProduct.php +++ b/src/FinancialProduct.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A product provided to consumers and businesses by financial institutions such * as banks, insurance companies, brokerage firms, consumer finance companies, @@ -9,9 +13,8 @@ * * @see http://schema.org/FinancialProduct * - * @mixin \Spatie\SchemaOrg\Service */ -class FinancialProduct extends BaseType +class FinancialProduct extends BaseType implements ServiceContract, IntangibleContract, ThingContract { /** * The annual rate that is charged for borrowing (or made by investing), @@ -60,4 +63,528 @@ public function interestRate($interestRate) return $this->setProperty('interestRate', $interestRate); } + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FinancialService.php b/src/FinancialService.php index 9ea6c0e13..8430fc247 100644 --- a/src/FinancialService.php +++ b/src/FinancialService.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Financial services business. * * @see http://schema.org/FinancialService * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class FinancialService extends BaseType +class FinancialService extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * Description of fees, commissions, and other terms applied either to a @@ -26,4 +30,1325 @@ public function feesAndCommissionsSpecification($feesAndCommissionsSpecification return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/FindAction.php b/src/FindAction.php index ba2c91d9d..103b87311 100644 --- a/src/FindAction.php +++ b/src/FindAction.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of finding an object. * @@ -12,8 +15,372 @@ * * @see http://schema.org/FindAction * - * @mixin \Spatie\SchemaOrg\Action */ -class FindAction extends BaseType +class FindAction extends BaseType implements ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FireStation.php b/src/FireStation.php index c0788be49..b03368bf4 100644 --- a/src/FireStation.php +++ b/src/FireStation.php @@ -2,14 +2,1340 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A fire station. With firemen. * * @see http://schema.org/FireStation * - * @mixin \Spatie\SchemaOrg\CivicStructure - * @mixin \Spatie\SchemaOrg\EmergencyService */ -class FireStation extends BaseType +class FireStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + } diff --git a/src/Flight.php b/src/Flight.php index 59be8ad34..b8415e5a8 100644 --- a/src/Flight.php +++ b/src/Flight.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TripContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An airline flight. * * @see http://schema.org/Flight * - * @mixin \Spatie\SchemaOrg\Trip */ -class Flight extends BaseType +class Flight extends BaseType implements TripContract, IntangibleContract, ThingContract { /** * The kind of aircraft (e.g., "Boeing 747"). @@ -226,4 +229,250 @@ public function webCheckinTime($webCheckinTime) return $this->setProperty('webCheckinTime', $webCheckinTime); } + /** + * The expected arrival time. + * + * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime + * + * @return static + * + * @see http://schema.org/arrivalTime + */ + public function arrivalTime($arrivalTime) + { + return $this->setProperty('arrivalTime', $arrivalTime); + } + + /** + * The expected departure time. + * + * @param \DateTimeInterface|\DateTimeInterface[] $departureTime + * + * @return static + * + * @see http://schema.org/departureTime + */ + public function departureTime($departureTime) + { + return $this->setProperty('departureTime', $departureTime); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FlightReservation.php b/src/FlightReservation.php index 3e244c15e..6a49bea5f 100644 --- a/src/FlightReservation.php +++ b/src/FlightReservation.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservation for air travel. * @@ -11,9 +15,8 @@ * * @see http://schema.org/FlightReservation * - * @mixin \Spatie\SchemaOrg\Reservation */ -class FlightReservation extends BaseType +class FlightReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** * The priority status assigned to a passenger for security or boarding @@ -58,4 +61,396 @@ public function securityScreening($securityScreening) return $this->setProperty('securityScreening', $securityScreening); } + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Florist.php b/src/Florist.php index 64c8fdacb..d3ea81a5b 100644 --- a/src/Florist.php +++ b/src/Florist.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A florist. * * @see http://schema.org/Florist * - * @mixin \Spatie\SchemaOrg\Store */ -class Florist extends BaseType +class Florist extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/FollowAction.php b/src/FollowAction.php index c60c762ae..4d4960ade 100644 --- a/src/FollowAction.php +++ b/src/FollowAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of forming a personal connection with someone/something (object) * unidirectionally/asymmetrically to get updates polled from. @@ -22,9 +26,8 @@ * * @see http://schema.org/FollowAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class FollowAction extends BaseType +class FollowAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { /** * A sub property of object. The person or organization being followed. @@ -40,4 +43,369 @@ public function followee($followee) return $this->setProperty('followee', $followee); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FoodEstablishment.php b/src/FoodEstablishment.php index 50e90e4b1..aa105203f 100644 --- a/src/FoodEstablishment.php +++ b/src/FoodEstablishment.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A food-related business. * * @see http://schema.org/FoodEstablishment * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class FoodEstablishment extends BaseType +class FoodEstablishment extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * Indicates whether a FoodEstablishment accepts reservations. Values can be @@ -88,4 +92,1325 @@ public function starRating($starRating) return $this->setProperty('starRating', $starRating); } + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/FoodEstablishmentReservation.php b/src/FoodEstablishmentReservation.php index 457ccbe42..c4f0a2c5b 100644 --- a/src/FoodEstablishmentReservation.php +++ b/src/FoodEstablishmentReservation.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservation to dine at a food-related business. * @@ -11,9 +15,8 @@ * * @see http://schema.org/FoodEstablishmentReservation * - * @mixin \Spatie\SchemaOrg\Reservation */ -class FoodEstablishmentReservation extends BaseType +class FoodEstablishmentReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** * The endTime of something. For a reserved event or service (e.g. @@ -75,4 +78,396 @@ public function startTime($startTime) return $this->setProperty('startTime', $startTime); } + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FoodEvent.php b/src/FoodEvent.php index fbf24e250..7656985d0 100644 --- a/src/FoodEvent.php +++ b/src/FoodEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Food event. * * @see http://schema.org/FoodEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class FoodEvent extends BaseType +class FoodEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FoodService.php b/src/FoodService.php index f84266c43..fb896806b 100644 --- a/src/FoodService.php +++ b/src/FoodService.php @@ -2,13 +2,540 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A food service, like breakfast, lunch, or dinner. * * @see http://schema.org/FoodService * - * @mixin \Spatie\SchemaOrg\Service */ -class FoodService extends BaseType +class FoodService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/FurnitureStore.php b/src/FurnitureStore.php index 3b221e0f3..228f95966 100644 --- a/src/FurnitureStore.php +++ b/src/FurnitureStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A furniture store. * * @see http://schema.org/FurnitureStore * - * @mixin \Spatie\SchemaOrg\Store */ -class FurnitureStore extends BaseType +class FurnitureStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Game.php b/src/Game.php index fc1da7fd8..d3e8d6778 100644 --- a/src/Game.php +++ b/src/Game.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The Game type represents things which are games. These are typically * rule-governed recreational activities, e.g. role-playing games in which @@ -9,9 +12,8 @@ * * @see http://schema.org/Game * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Game extends BaseType +class Game extends BaseType implements CreativeWorkContract, ThingContract { /** * A piece of data that represents a particular aspect of a fictional @@ -86,4 +88,1509 @@ public function quest($quest) return $this->setProperty('quest', $quest); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GamePlayMode.php b/src/GamePlayMode.php index 48e28ef2b..e1a9aff44 100644 --- a/src/GamePlayMode.php +++ b/src/GamePlayMode.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Indicates whether this game is multi-player, co-op or single-player. * * @see http://schema.org/GamePlayMode * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class GamePlayMode extends BaseType +class GamePlayMode extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * Play mode: CoOp. Co-operative games, where you play on the same team with @@ -34,4 +37,190 @@ class GamePlayMode extends BaseType */ const SinglePlayer = 'http://schema.org/SinglePlayer'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GameServer.php b/src/GameServer.php index 011e6fb3e..557048593 100644 --- a/src/GameServer.php +++ b/src/GameServer.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Server that provides game interaction in a multiplayer game. * * @see http://schema.org/GameServer * - * @mixin \Spatie\SchemaOrg\Intangible */ -class GameServer extends BaseType +class GameServer extends BaseType implements IntangibleContract, ThingContract { /** * Video game which is played on this server. @@ -53,4 +55,190 @@ public function serverStatus($serverStatus) return $this->setProperty('serverStatus', $serverStatus); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GameServerStatus.php b/src/GameServerStatus.php index 27e5da3c7..e9be75091 100644 --- a/src/GameServerStatus.php +++ b/src/GameServerStatus.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Status of a game server. * * @see http://schema.org/GameServerStatus * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class GameServerStatus extends BaseType +class GameServerStatus extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * Game server status: OfflinePermanently. Server is offline and not @@ -42,4 +45,190 @@ class GameServerStatus extends BaseType */ const OnlineFull = 'http://schema.org/OnlineFull'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GardenStore.php b/src/GardenStore.php index 2b6cf3cd7..66f44a2c2 100644 --- a/src/GardenStore.php +++ b/src/GardenStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A garden store. * * @see http://schema.org/GardenStore * - * @mixin \Spatie\SchemaOrg\Store */ -class GardenStore extends BaseType +class GardenStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/GasStation.php b/src/GasStation.php index 0047e8ff3..bd146f127 100644 --- a/src/GasStation.php +++ b/src/GasStation.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A gas station. * * @see http://schema.org/GasStation * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness */ -class GasStation extends BaseType +class GasStation extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/GatedResidenceCommunity.php b/src/GatedResidenceCommunity.php index c9669447b..e3a64795b 100644 --- a/src/GatedResidenceCommunity.php +++ b/src/GatedResidenceCommunity.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ResidenceContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Residence type: Gated community. * * @see http://schema.org/GatedResidenceCommunity * - * @mixin \Spatie\SchemaOrg\Residence */ -class GatedResidenceCommunity extends BaseType +class GatedResidenceCommunity extends BaseType implements ResidenceContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GenderType.php b/src/GenderType.php index f80a5d576..bc07dca23 100644 --- a/src/GenderType.php +++ b/src/GenderType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An enumeration of genders. * * @see http://schema.org/GenderType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class GenderType extends BaseType +class GenderType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * The female gender. @@ -25,4 +28,190 @@ class GenderType extends BaseType */ const Male = 'http://schema.org/Male'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GeneralContractor.php b/src/GeneralContractor.php index c1db9d52c..1212d36ef 100644 --- a/src/GeneralContractor.php +++ b/src/GeneralContractor.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HomeAndConstructionBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A general contractor. * * @see http://schema.org/GeneralContractor * - * @mixin \Spatie\SchemaOrg\HomeAndConstructionBusiness */ -class GeneralContractor extends BaseType +class GeneralContractor extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/GeoCircle.php b/src/GeoCircle.php index 790f9d378..ffb47d010 100644 --- a/src/GeoCircle.php +++ b/src/GeoCircle.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\GeoShapeContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A GeoCircle is a GeoShape representing a circular geographic area. As it is a * GeoShape @@ -12,9 +17,8 @@ * * @see http://schema.org/GeoCircle * - * @mixin \Spatie\SchemaOrg\GeoShape */ -class GeoCircle extends BaseType +class GeoCircle extends BaseType implements GeoShapeContract, StructuredValueContract, IntangibleContract, ThingContract { /** * Indicates the approximate radius of a GeoCircle (metres unless indicated @@ -31,4 +35,328 @@ public function geoRadius($geoRadius) return $this->setProperty('geoRadius', $geoRadius); } + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The country. For example, USA. You can also provide the two-letter [ISO + * 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1). + * + * @param Country|Country[]|string|string[] $addressCountry + * + * @return static + * + * @see http://schema.org/addressCountry + */ + public function addressCountry($addressCountry) + { + return $this->setProperty('addressCountry', $addressCountry); + } + + /** + * A box is the area enclosed by the rectangle formed by two points. The + * first point is the lower corner, the second point is the upper corner. A + * box is expressed as two points separated by a space character. + * + * @param string|string[] $box + * + * @return static + * + * @see http://schema.org/box + */ + public function box($box) + { + return $this->setProperty('box', $box); + } + + /** + * A circle is the circular region of a specified radius centered at a + * specified latitude and longitude. A circle is expressed as a pair + * followed by a radius in meters. + * + * @param string|string[] $circle + * + * @return static + * + * @see http://schema.org/circle + */ + public function circle($circle) + { + return $this->setProperty('circle', $circle); + } + + /** + * The elevation of a location ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be + * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') + * while numbers alone should be assumed to be a value in meters. + * + * @param float|float[]|int|int[]|string|string[] $elevation + * + * @return static + * + * @see http://schema.org/elevation + */ + public function elevation($elevation) + { + return $this->setProperty('elevation', $elevation); + } + + /** + * Indicates the GeoCoordinates at the centre of a GeoShape e.g. GeoCircle. + * + * @param GeoCoordinates|GeoCoordinates[] $geoMidpoint + * + * @return static + * + * @see http://schema.org/geoMidpoint + */ + public function geoMidpoint($geoMidpoint) + { + return $this->setProperty('geoMidpoint', $geoMidpoint); + } + + /** + * A line is a point-to-point path consisting of two or more points. A line + * is expressed as a series of two or more point objects separated by space. + * + * @param string|string[] $line + * + * @return static + * + * @see http://schema.org/line + */ + public function line($line) + { + return $this->setProperty('line', $line); + } + + /** + * A polygon is the area enclosed by a point-to-point path for which the + * starting and ending points are the same. A polygon is expressed as a + * series of four or more space delimited points where the first and final + * points are identical. + * + * @param string|string[] $polygon + * + * @return static + * + * @see http://schema.org/polygon + */ + public function polygon($polygon) + { + return $this->setProperty('polygon', $polygon); + } + + /** + * The postal code. For example, 94043. + * + * @param string|string[] $postalCode + * + * @return static + * + * @see http://schema.org/postalCode + */ + public function postalCode($postalCode) + { + return $this->setProperty('postalCode', $postalCode); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GeoCoordinates.php b/src/GeoCoordinates.php index e9862952b..2c44b658f 100644 --- a/src/GeoCoordinates.php +++ b/src/GeoCoordinates.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The geographic coordinates of a place or event. * * @see http://schema.org/GeoCoordinates * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class GeoCoordinates extends BaseType +class GeoCoordinates extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * Physical address of the item. @@ -101,4 +104,190 @@ public function postalCode($postalCode) return $this->setProperty('postalCode', $postalCode); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GeoShape.php b/src/GeoShape.php index a7e18cdc9..ec0b97df2 100644 --- a/src/GeoShape.php +++ b/src/GeoShape.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The geographic shape of a place. A GeoShape can be described using several * properties whose values are based on latitude/longitude pairs. Either @@ -10,9 +14,8 @@ * * @see http://schema.org/GeoShape * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class GeoShape extends BaseType +class GeoShape extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * Physical address of the item. @@ -152,4 +155,190 @@ public function postalCode($postalCode) return $this->setProperty('postalCode', $postalCode); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GiveAction.php b/src/GiveAction.php index 6907def26..1f40ac9ff 100644 --- a/src/GiveAction.php +++ b/src/GiveAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of transferring ownership of an object to a destination. Reciprocal * of TakeAction. @@ -15,9 +19,8 @@ * * @see http://schema.org/GiveAction * - * @mixin \Spatie\SchemaOrg\TransferAction */ -class GiveAction extends BaseType +class GiveAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** * A sub property of participant. The participant who is at the receiving @@ -34,4 +37,399 @@ public function recipient($recipient) return $this->setProperty('recipient', $recipient); } + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GolfCourse.php b/src/GolfCourse.php index 579e53141..8281a5447 100644 --- a/src/GolfCourse.php +++ b/src/GolfCourse.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A golf course. * * @see http://schema.org/GolfCourse * - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class GolfCourse extends BaseType +class GolfCourse extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/GovernmentBuilding.php b/src/GovernmentBuilding.php index 5d1de6e07..49220b2c8 100644 --- a/src/GovernmentBuilding.php +++ b/src/GovernmentBuilding.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A government building. * * @see http://schema.org/GovernmentBuilding * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class GovernmentBuilding extends BaseType +class GovernmentBuilding extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GovernmentOffice.php b/src/GovernmentOffice.php index 2330a496b..90a73c26a 100644 --- a/src/GovernmentOffice.php +++ b/src/GovernmentOffice.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A government office—for example, an IRS or DMV office. * * @see http://schema.org/GovernmentOffice * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class GovernmentOffice extends BaseType +class GovernmentOffice extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/GovernmentOrganization.php b/src/GovernmentOrganization.php index 71f321b1d..3e6efe3db 100644 --- a/src/GovernmentOrganization.php +++ b/src/GovernmentOrganization.php @@ -2,13 +2,937 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A governmental organization or agency. * * @see http://schema.org/GovernmentOrganization * - * @mixin \Spatie\SchemaOrg\Organization */ -class GovernmentOrganization extends BaseType +class GovernmentOrganization extends BaseType implements OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GovernmentPermit.php b/src/GovernmentPermit.php index 9d78997b9..5508efa86 100644 --- a/src/GovernmentPermit.php +++ b/src/GovernmentPermit.php @@ -2,13 +2,300 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PermitContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A permit issued by a government agency. * * @see http://schema.org/GovernmentPermit * - * @mixin \Spatie\SchemaOrg\Permit */ -class GovernmentPermit extends BaseType +class GovernmentPermit extends BaseType implements PermitContract, IntangibleContract, ThingContract { + /** + * The organization issuing the ticket or permit. + * + * @param Organization|Organization[] $issuedBy + * + * @return static + * + * @see http://schema.org/issuedBy + */ + public function issuedBy($issuedBy) + { + return $this->setProperty('issuedBy', $issuedBy); + } + + /** + * The service through with the permit was granted. + * + * @param Service|Service[] $issuedThrough + * + * @return static + * + * @see http://schema.org/issuedThrough + */ + public function issuedThrough($issuedThrough) + { + return $this->setProperty('issuedThrough', $issuedThrough); + } + + /** + * The target audience for this permit. + * + * @param Audience|Audience[] $permitAudience + * + * @return static + * + * @see http://schema.org/permitAudience + */ + public function permitAudience($permitAudience) + { + return $this->setProperty('permitAudience', $permitAudience); + } + + /** + * The duration of validity of a permit or similar thing. + * + * @param Duration|Duration[] $validFor + * + * @return static + * + * @see http://schema.org/validFor + */ + public function validFor($validFor) + { + return $this->setProperty('validFor', $validFor); + } + + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The geographic area where a permit or similar thing is valid. + * + * @param AdministrativeArea|AdministrativeArea[] $validIn + * + * @return static + * + * @see http://schema.org/validIn + */ + public function validIn($validIn) + { + return $this->setProperty('validIn', $validIn); + } + + /** + * The date when the item is no longer valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validUntil + * + * @return static + * + * @see http://schema.org/validUntil + */ + public function validUntil($validUntil) + { + return $this->setProperty('validUntil', $validUntil); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GovernmentService.php b/src/GovernmentService.php index 7bbcac1b6..129e31528 100644 --- a/src/GovernmentService.php +++ b/src/GovernmentService.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A service provided by a government organization, e.g. food stamps, veterans * benefits, etc. * * @see http://schema.org/GovernmentService * - * @mixin \Spatie\SchemaOrg\Service */ -class GovernmentService extends BaseType +class GovernmentService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { /** * The operating organization, if different from the provider. This enables @@ -28,4 +31,528 @@ public function serviceOperator($serviceOperator) return $this->setProperty('serviceOperator', $serviceOperator); } + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/GroceryStore.php b/src/GroceryStore.php index a3dfc319d..db3d921af 100644 --- a/src/GroceryStore.php +++ b/src/GroceryStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A grocery store. * * @see http://schema.org/GroceryStore * - * @mixin \Spatie\SchemaOrg\Store */ -class GroceryStore extends BaseType +class GroceryStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HVACBusiness.php b/src/HVACBusiness.php index 5c18e4b5f..a752c66c2 100644 --- a/src/HVACBusiness.php +++ b/src/HVACBusiness.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HomeAndConstructionBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A business that provide Heating, Ventilation and Air Conditioning services. * * @see http://schema.org/HVACBusiness * - * @mixin \Spatie\SchemaOrg\HomeAndConstructionBusiness */ -class HVACBusiness extends BaseType +class HVACBusiness extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HairSalon.php b/src/HairSalon.php index 22fdae5d6..062c15802 100644 --- a/src/HairSalon.php +++ b/src/HairSalon.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HealthAndBeautyBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A hair salon. * * @see http://schema.org/HairSalon * - * @mixin \Spatie\SchemaOrg\HealthAndBeautyBusiness */ -class HairSalon extends BaseType +class HairSalon extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HardwareStore.php b/src/HardwareStore.php index 5fe1693ca..f2b24ce2f 100644 --- a/src/HardwareStore.php +++ b/src/HardwareStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A hardware store. * * @see http://schema.org/HardwareStore * - * @mixin \Spatie\SchemaOrg\Store */ -class HardwareStore extends BaseType +class HardwareStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HealthAndBeautyBusiness.php b/src/HealthAndBeautyBusiness.php index f07be1b22..1b06a5dcf 100644 --- a/src/HealthAndBeautyBusiness.php +++ b/src/HealthAndBeautyBusiness.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Health and beauty. * * @see http://schema.org/HealthAndBeautyBusiness * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class HealthAndBeautyBusiness extends BaseType +class HealthAndBeautyBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HealthClub.php b/src/HealthClub.php index a82ac745a..e93f94741 100644 --- a/src/HealthClub.php +++ b/src/HealthClub.php @@ -2,14 +2,1340 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HealthAndBeautyBusinessContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A health club. * * @see http://schema.org/HealthClub * - * @mixin \Spatie\SchemaOrg\HealthAndBeautyBusiness - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class HealthClub extends BaseType +class HealthClub extends BaseType implements HealthAndBeautyBusinessContract, SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HighSchool.php b/src/HighSchool.php index 759aaa210..41029b46b 100644 --- a/src/HighSchool.php +++ b/src/HighSchool.php @@ -2,13 +2,952 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EducationalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A high school. * * @see http://schema.org/HighSchool * - * @mixin \Spatie\SchemaOrg\EducationalOrganization */ -class HighSchool extends BaseType +class HighSchool extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/HinduTemple.php b/src/HinduTemple.php index 350d863d7..de9b412d2 100644 --- a/src/HinduTemple.php +++ b/src/HinduTemple.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Hindu temple. * * @see http://schema.org/HinduTemple * - * @mixin \Spatie\SchemaOrg\PlaceOfWorship */ -class HinduTemple extends BaseType +class HinduTemple extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/HobbyShop.php b/src/HobbyShop.php index 5426c2e72..3aecfe5c9 100644 --- a/src/HobbyShop.php +++ b/src/HobbyShop.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A store that sells materials useful or necessary for various hobbies. * * @see http://schema.org/HobbyShop * - * @mixin \Spatie\SchemaOrg\Store */ -class HobbyShop extends BaseType +class HobbyShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HomeAndConstructionBusiness.php b/src/HomeAndConstructionBusiness.php index c3ba3650e..f5ab07264 100644 --- a/src/HomeAndConstructionBusiness.php +++ b/src/HomeAndConstructionBusiness.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A construction business. * @@ -13,8 +18,1328 @@ * * @see http://schema.org/HomeAndConstructionBusiness * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class HomeAndConstructionBusiness extends BaseType +class HomeAndConstructionBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HomeGoodsStore.php b/src/HomeGoodsStore.php index 1115ef39a..7498abd15 100644 --- a/src/HomeGoodsStore.php +++ b/src/HomeGoodsStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A home goods store. * * @see http://schema.org/HomeGoodsStore * - * @mixin \Spatie\SchemaOrg\Store */ -class HomeGoodsStore extends BaseType +class HomeGoodsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Hospital.php b/src/Hospital.php index 11cdfd95b..3c5f20388 100644 --- a/src/Hospital.php +++ b/src/Hospital.php @@ -2,15 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; +use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A hospital. * * @see http://schema.org/Hospital * - * @mixin \Spatie\SchemaOrg\CivicStructure - * @mixin \Spatie\SchemaOrg\EmergencyService - * @mixin \Spatie\SchemaOrg\MedicalOrganization */ -class Hospital extends BaseType +class Hospital extends BaseType implements CivicStructureContract, EmergencyServiceContract, MedicalOrganizationContract, OrganizationContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + } diff --git a/src/Hostel.php b/src/Hostel.php index 295bf75a1..edb19f2d2 100644 --- a/src/Hostel.php +++ b/src/Hostel.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A hostel - cheap accommodation, often in shared dormitories. * @@ -10,8 +16,1435 @@ * * @see http://schema.org/Hostel * - * @mixin \Spatie\SchemaOrg\LodgingBusiness */ -class Hostel extends BaseType +class Hostel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * + * @param Language|Language[]|string|string[] $availableLanguage + * + * @return static + * + * @see http://schema.org/availableLanguage + */ + public function availableLanguage($availableLanguage) + { + return $this->setProperty('availableLanguage', $availableLanguage); + } + + /** + * The earliest someone may check into a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * + * @return static + * + * @see http://schema.org/checkinTime + */ + public function checkinTime($checkinTime) + { + return $this->setProperty('checkinTime', $checkinTime); + } + + /** + * The latest someone may check out of a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * + * @return static + * + * @see http://schema.org/checkoutTime + */ + public function checkoutTime($checkoutTime) + { + return $this->setProperty('checkoutTime', $checkoutTime); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Hotel.php b/src/Hotel.php index dab1b3112..1dd053b67 100644 --- a/src/Hotel.php +++ b/src/Hotel.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A hotel is an establishment that provides lodging paid on a short-term basis * (Source: Wikipedia, the free encyclopedia, see @@ -12,8 +18,1435 @@ * * @see http://schema.org/Hotel * - * @mixin \Spatie\SchemaOrg\LodgingBusiness */ -class Hotel extends BaseType +class Hotel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * + * @param Language|Language[]|string|string[] $availableLanguage + * + * @return static + * + * @see http://schema.org/availableLanguage + */ + public function availableLanguage($availableLanguage) + { + return $this->setProperty('availableLanguage', $availableLanguage); + } + + /** + * The earliest someone may check into a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * + * @return static + * + * @see http://schema.org/checkinTime + */ + public function checkinTime($checkinTime) + { + return $this->setProperty('checkinTime', $checkinTime); + } + + /** + * The latest someone may check out of a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * + * @return static + * + * @see http://schema.org/checkoutTime + */ + public function checkoutTime($checkoutTime) + { + return $this->setProperty('checkoutTime', $checkoutTime); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HotelRoom.php b/src/HotelRoom.php index c7b1a19c9..5e7d6fcad 100644 --- a/src/HotelRoom.php +++ b/src/HotelRoom.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\RoomContract; +use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A hotel room is a single room in a hotel. * @@ -10,9 +15,8 @@ * * @see http://schema.org/HotelRoom * - * @mixin \Spatie\SchemaOrg\Room */ -class HotelRoom extends BaseType +class HotelRoom extends BaseType implements RoomContract, AccommodationContract, PlaceContract, ThingContract { /** * The type of bed or beds included in the accommodation. For the single @@ -50,4 +54,732 @@ public function occupancy($occupancy) return $this->setProperty('occupancy', $occupancy); } + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indications regarding the permitted usage of the accommodation. + * + * @param string|string[] $permittedUsage + * + * @return static + * + * @see http://schema.org/permittedUsage + */ + public function permittedUsage($permittedUsage) + { + return $this->setProperty('permittedUsage', $permittedUsage); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/House.php b/src/House.php index b10159253..9f9d3a486 100644 --- a/src/House.php +++ b/src/House.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A house is a building or structure that has the ability to be occupied for * habitation by humans or other creatures (Source: Wikipedia, the free @@ -10,9 +14,8 @@ * * @see http://schema.org/House * - * @mixin \Spatie\SchemaOrg\Accommodation */ -class House extends BaseType +class House extends BaseType implements AccommodationContract, PlaceContract, ThingContract { /** * The number of rooms (excluding bathrooms and closets) of the @@ -31,4 +34,732 @@ public function numberOfRooms($numberOfRooms) return $this->setProperty('numberOfRooms', $numberOfRooms); } + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indications regarding the permitted usage of the accommodation. + * + * @param string|string[] $permittedUsage + * + * @return static + * + * @see http://schema.org/permittedUsage + */ + public function permittedUsage($permittedUsage) + { + return $this->setProperty('permittedUsage', $permittedUsage); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/HousePainter.php b/src/HousePainter.php index 682d89f53..663e04e5e 100644 --- a/src/HousePainter.php +++ b/src/HousePainter.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HomeAndConstructionBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A house painting service. * * @see http://schema.org/HousePainter * - * @mixin \Spatie\SchemaOrg\HomeAndConstructionBusiness */ -class HousePainter extends BaseType +class HousePainter extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/HowTo.php b/src/HowTo.php index e2206d715..72d9c372e 100644 --- a/src/HowTo.php +++ b/src/HowTo.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Instructions that explain how to achieve a result by performing a sequence of * steps. * * @see http://schema.org/HowTo * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class HowTo extends BaseType +class HowTo extends BaseType implements CreativeWorkContract, ThingContract { /** * The estimated cost of the supply or supplies consumed when performing @@ -150,4 +152,1509 @@ public function yield($yield) return $this->setProperty('yield', $yield); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/HowToDirection.php b/src/HowToDirection.php index 8c155aba7..313de26d8 100644 --- a/src/HowToDirection.php +++ b/src/HowToDirection.php @@ -2,16 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ListItemContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A direction indicating a single action to do in the instructions for how to * achieve a result. * * @see http://schema.org/HowToDirection * - * @mixin \Spatie\SchemaOrg\ListItem - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class HowToDirection extends BaseType +class HowToDirection extends BaseType implements ListItemContract, CreativeWorkContract, ThingContract { /** * A media object representing the circumstances after performing this @@ -136,4 +138,1552 @@ public function totalTime($totalTime) return $this->setProperty('totalTime', $totalTime); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + } diff --git a/src/HowToItem.php b/src/HowToItem.php index cdda23952..eb7bb0df5 100644 --- a/src/HowToItem.php +++ b/src/HowToItem.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ListItemContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An item used as either a tool or supply when performing the instructions for * how to to achieve a result. * * @see http://schema.org/HowToItem * - * @mixin \Spatie\SchemaOrg\ListItem */ -class HowToItem extends BaseType +class HowToItem extends BaseType implements ListItemContract, IntangibleContract, ThingContract { /** * The required quantity of the item(s). @@ -26,4 +29,247 @@ public function requiredQuantity($requiredQuantity) return $this->setProperty('requiredQuantity', $requiredQuantity); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/HowToSection.php b/src/HowToSection.php index d9c10897b..3cf40d781 100644 --- a/src/HowToSection.php +++ b/src/HowToSection.php @@ -2,17 +2,19 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ItemListContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A sub-grouping of steps in the instructions for how to achieve a result (e.g. * steps for making a pie crust within a pie recipe). * * @see http://schema.org/HowToSection * - * @mixin \Spatie\SchemaOrg\ItemList - * @mixin \Spatie\SchemaOrg\ListItem - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class HowToSection extends BaseType +class HowToSection extends BaseType implements ItemListContract, ListItemContract, CreativeWorkContract, ThingContract { /** * A single step item (as HowToStep, text, document, video, etc.) or a @@ -29,4 +31,1607 @@ public function steps($steps) return $this->setProperty('steps', $steps); } + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + } diff --git a/src/HowToStep.php b/src/HowToStep.php index c31dbe67e..40bc4cd91 100644 --- a/src/HowToStep.php +++ b/src/HowToStep.php @@ -2,16 +2,1621 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ListItemContract; +use \Spatie\SchemaOrg\Contracts\ItemListContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A step in the instructions for how to achieve a result. It is an ordered list * with HowToDirection and/or HowToTip items. * * @see http://schema.org/HowToStep * - * @mixin \Spatie\SchemaOrg\ListItem - * @mixin \Spatie\SchemaOrg\ItemList - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class HowToStep extends BaseType +class HowToStep extends BaseType implements ListItemContract, ItemListContract, CreativeWorkContract, ThingContract { + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + } diff --git a/src/HowToSupply.php b/src/HowToSupply.php index 9be90c3e4..b1bb25ec7 100644 --- a/src/HowToSupply.php +++ b/src/HowToSupply.php @@ -2,15 +2,19 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HowToItemContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A supply consumed when performing the instructions for how to achieve a * result. * * @see http://schema.org/HowToSupply * - * @mixin \Spatie\SchemaOrg\HowToItem */ -class HowToSupply extends BaseType +class HowToSupply extends BaseType implements HowToItemContract, ListItemContract, IntangibleContract, ThingContract { /** * The estimated cost of the supply or supplies consumed when performing @@ -27,4 +31,261 @@ public function estimatedCost($estimatedCost) return $this->setProperty('estimatedCost', $estimatedCost); } + /** + * The required quantity of the item(s). + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[]|string|string[] $requiredQuantity + * + * @return static + * + * @see http://schema.org/requiredQuantity + */ + public function requiredQuantity($requiredQuantity) + { + return $this->setProperty('requiredQuantity', $requiredQuantity); + } + + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/HowToTip.php b/src/HowToTip.php index 4913e9b8a..aad7f3b20 100644 --- a/src/HowToTip.php +++ b/src/HowToTip.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ListItemContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An explanation in the instructions for how to achieve a result. It provides * supplementary information about a technique, supply, author's preference, @@ -10,9 +14,1555 @@ * * @see http://schema.org/HowToTip * - * @mixin \Spatie\SchemaOrg\ListItem - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class HowToTip extends BaseType +class HowToTip extends BaseType implements ListItemContract, CreativeWorkContract, ThingContract { + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + } diff --git a/src/HowToTool.php b/src/HowToTool.php index 08e9fa8bb..7b18a7111 100644 --- a/src/HowToTool.php +++ b/src/HowToTool.php @@ -2,14 +2,275 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HowToItemContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A tool used (but not consumed) when performing instructions for how to * achieve a result. * * @see http://schema.org/HowToTool * - * @mixin \Spatie\SchemaOrg\HowToItem */ -class HowToTool extends BaseType +class HowToTool extends BaseType implements HowToItemContract, ListItemContract, IntangibleContract, ThingContract { + /** + * The required quantity of the item(s). + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[]|string|string[] $requiredQuantity + * + * @return static + * + * @see http://schema.org/requiredQuantity + */ + public function requiredQuantity($requiredQuantity) + { + return $this->setProperty('requiredQuantity', $requiredQuantity); + } + + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/IceCreamShop.php b/src/IceCreamShop.php index 9f754107b..2998f2606 100644 --- a/src/IceCreamShop.php +++ b/src/IceCreamShop.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An ice cream shop. * * @see http://schema.org/IceCreamShop * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class IceCreamShop extends BaseType +class IceCreamShop extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/IgnoreAction.php b/src/IgnoreAction.php index 6dcd12285..27af8d4cd 100644 --- a/src/IgnoreAction.php +++ b/src/IgnoreAction.php @@ -2,13 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of intentionally disregarding the object. An agent ignores an object. * * @see http://schema.org/IgnoreAction * - * @mixin \Spatie\SchemaOrg\AssessAction */ -class IgnoreAction extends BaseType +class IgnoreAction extends BaseType implements AssessActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ImageGallery.php b/src/ImageGallery.php index 8cd103562..8887df8ba 100644 --- a/src/ImageGallery.php +++ b/src/ImageGallery.php @@ -2,13 +2,1692 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CollectionPageContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web page type: Image gallery page. * * @see http://schema.org/ImageGallery * - * @mixin \Spatie\SchemaOrg\CollectionPage */ -class ImageGallery extends BaseType +class ImageGallery extends BaseType implements CollectionPageContract, WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ImageObject.php b/src/ImageObject.php index 0c468df74..816fe6a73 100644 --- a/src/ImageObject.php +++ b/src/ImageObject.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An image file. * * @see http://schema.org/ImageObject * - * @mixin \Spatie\SchemaOrg\MediaObject */ -class ImageObject extends BaseType +class ImageObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { /** * The caption for this object. For downloadable machine formats (closed @@ -70,4 +73,1760 @@ public function thumbnail($thumbnail) return $this->setProperty('thumbnail', $thumbnail); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Date when this media object was uploaded to this site. + * + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate + * + * @return static + * + * @see http://schema.org/uploadDate + */ + public function uploadDate($uploadDate) + { + return $this->setProperty('uploadDate', $uploadDate); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/IndividualProduct.php b/src/IndividualProduct.php index 69fee5d4b..8be401b68 100644 --- a/src/IndividualProduct.php +++ b/src/IndividualProduct.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ProductContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A single, identifiable product instance (e.g. a laptop with a particular * serial number). * * @see http://schema.org/IndividualProduct * - * @mixin \Spatie\SchemaOrg\Product */ -class IndividualProduct extends BaseType +class IndividualProduct extends BaseType implements ProductContract, ThingContract { /** * The serial number or any alphanumeric identifier of a particular product. @@ -28,4 +30,724 @@ public function serialNumber($serialNumber) return $this->setProperty('serialNumber', $serialNumber); } + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * The color of the product. + * + * @param string|string[] $color + * + * @return static + * + * @see http://schema.org/color + */ + public function color($color) + { + return $this->setProperty('color', $color); + } + + /** + * The depth of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth + * + * @return static + * + * @see http://schema.org/depth + */ + public function depth($depth) + { + return $this->setProperty('depth', $depth); + } + + /** + * The GTIN-12 code of the product, or the product to which the offer + * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a + * U.P.C. Company Prefix, Item Reference, and Check Digit used to identify + * trade items. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin12 + * + * @return static + * + * @see http://schema.org/gtin12 + */ + public function gtin12($gtin12) + { + return $this->setProperty('gtin12', $gtin12); + } + + /** + * The GTIN-13 code of the product, or the product to which the offer + * refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former + * 12-digit UPC codes can be converted into a GTIN-13 code by simply adding + * a preceeding zero. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin13 + * + * @return static + * + * @see http://schema.org/gtin13 + */ + public function gtin13($gtin13) + { + return $this->setProperty('gtin13', $gtin13); + } + + /** + * The GTIN-14 code of the product, or the product to which the offer + * refers. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin14 + * + * @return static + * + * @see http://schema.org/gtin14 + */ + public function gtin14($gtin14) + { + return $this->setProperty('gtin14', $gtin14); + } + + /** + * The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of + * the product, or the product to which the offer refers. This code is also + * known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin8 + * + * @return static + * + * @see http://schema.org/gtin8 + */ + public function gtin8($gtin8) + { + return $this->setProperty('gtin8', $gtin8); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is an accessory or spare part. + * + * @param Product|Product[] $isAccessoryOrSparePartFor + * + * @return static + * + * @see http://schema.org/isAccessoryOrSparePartFor + */ + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor) + { + return $this->setProperty('isAccessoryOrSparePartFor', $isAccessoryOrSparePartFor); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is a consumable. + * + * @param Product|Product[] $isConsumableFor + * + * @return static + * + * @see http://schema.org/isConsumableFor + */ + public function isConsumableFor($isConsumableFor) + { + return $this->setProperty('isConsumableFor', $isConsumableFor); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * A predefined value from OfferItemCondition or a textual description of + * the condition of the product or service, or the products or services + * included in the offer. + * + * @param OfferItemCondition|OfferItemCondition[] $itemCondition + * + * @return static + * + * @see http://schema.org/itemCondition + */ + public function itemCondition($itemCondition) + { + return $this->setProperty('itemCondition', $itemCondition); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The manufacturer of the product. + * + * @param Organization|Organization[] $manufacturer + * + * @return static + * + * @see http://schema.org/manufacturer + */ + public function manufacturer($manufacturer) + { + return $this->setProperty('manufacturer', $manufacturer); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * The model of the product. Use with the URL of a ProductModel or a textual + * representation of the model identifier. The URL of the ProductModel can + * be from an external source. It is recommended to additionally provide + * strong product identifiers via the gtin8/gtin13/gtin14 and mpn + * properties. + * + * @param ProductModel|ProductModel[]|string|string[] $model + * + * @return static + * + * @see http://schema.org/model + */ + public function model($model) + { + return $this->setProperty('model', $model); + } + + /** + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. + * + * @param string|string[] $mpn + * + * @return static + * + * @see http://schema.org/mpn + */ + public function mpn($mpn) + { + return $this->setProperty('mpn', $mpn); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The product identifier, such as ISBN. For example: ``` meta + * itemprop="productID" content="isbn:123-456-789" ```. + * + * @param string|string[] $productID + * + * @return static + * + * @see http://schema.org/productID + */ + public function productID($productID) + { + return $this->setProperty('productID', $productID); + } + + /** + * The date of production of the item, e.g. vehicle. + * + * @param \DateTimeInterface|\DateTimeInterface[] $productionDate + * + * @return static + * + * @see http://schema.org/productionDate + */ + public function productionDate($productionDate) + { + return $this->setProperty('productionDate', $productionDate); + } + + /** + * The date the item e.g. vehicle was purchased by the current owner. + * + * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate + * + * @return static + * + * @see http://schema.org/purchaseDate + */ + public function purchaseDate($purchaseDate) + { + return $this->setProperty('purchaseDate', $purchaseDate); + } + + /** + * The release date of a product or product model. This can be used to + * distinguish the exact variant of a product. + * + * @param \DateTimeInterface|\DateTimeInterface[] $releaseDate + * + * @return static + * + * @see http://schema.org/releaseDate + */ + public function releaseDate($releaseDate) + { + return $this->setProperty('releaseDate', $releaseDate); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a + * product or service, or the product to which the offer refers. + * + * @param string|string[] $sku + * + * @return static + * + * @see http://schema.org/sku + */ + public function sku($sku) + { + return $this->setProperty('sku', $sku); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * The weight of the product or person. + * + * @param QuantitativeValue|QuantitativeValue[] $weight + * + * @return static + * + * @see http://schema.org/weight + */ + public function weight($weight) + { + return $this->setProperty('weight', $weight); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/InformAction.php b/src/InformAction.php index 98f97fbc9..7ef90ace0 100644 --- a/src/InformAction.php +++ b/src/InformAction.php @@ -2,15 +2,19 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of notifying someone of information pertinent to them, with no * expectation of a response. * * @see http://schema.org/InformAction * - * @mixin \Spatie\SchemaOrg\CommunicateAction */ -class InformAction extends BaseType +class InformAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** * Upcoming or past event associated with this place, organization, or @@ -27,4 +31,429 @@ public function event($event) return $this->setProperty('event', $event); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/InsertAction.php b/src/InsertAction.php index 5969f848f..2f5b3008a 100644 --- a/src/InsertAction.php +++ b/src/InsertAction.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AddActionContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of adding at a specific location in an ordered collection. * * @see http://schema.org/InsertAction * - * @mixin \Spatie\SchemaOrg\AddAction */ -class InsertAction extends BaseType +class InsertAction extends BaseType implements AddActionContract, UpdateActionContract, ActionContract, ThingContract { /** * A sub property of location. The final location of the object or the agent @@ -26,4 +30,397 @@ public function toLocation($toLocation) return $this->setProperty('toLocation', $toLocation); } + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $collection + * + * @return static + * + * @see http://schema.org/collection + */ + public function collection($collection) + { + return $this->setProperty('collection', $collection); + } + + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $targetCollection + * + * @return static + * + * @see http://schema.org/targetCollection + */ + public function targetCollection($targetCollection) + { + return $this->setProperty('targetCollection', $targetCollection); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/InstallAction.php b/src/InstallAction.php index 0d251753a..2f9a40677 100644 --- a/src/InstallAction.php +++ b/src/InstallAction.php @@ -2,13 +2,413 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of installing an application. * * @see http://schema.org/InstallAction * - * @mixin \Spatie\SchemaOrg\ConsumeAction */ -class InstallAction extends BaseType +class InstallAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/InsuranceAgency.php b/src/InsuranceAgency.php index 4b83132f2..2fcee347a 100644 --- a/src/InsuranceAgency.php +++ b/src/InsuranceAgency.php @@ -2,13 +2,1354 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An Insurance agency. * * @see http://schema.org/InsuranceAgency * - * @mixin \Spatie\SchemaOrg\FinancialService */ -class InsuranceAgency extends BaseType +class InsuranceAgency extends BaseType implements FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Intangible.php b/src/Intangible.php index 3bf557f08..b1cff7c8a 100644 --- a/src/Intangible.php +++ b/src/Intangible.php @@ -2,14 +2,201 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A utility class that serves as the umbrella for a number of 'intangible' * things such as quantities, structured values, etc. * * @see http://schema.org/Intangible * - * @mixin \Spatie\SchemaOrg\Thing */ -class Intangible extends BaseType +class Intangible extends BaseType implements ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/InteractAction.php b/src/InteractAction.php index 4b2edf547..5e20f33a6 100644 --- a/src/InteractAction.php +++ b/src/InteractAction.php @@ -2,13 +2,380 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of interacting with another person or organization. * * @see http://schema.org/InteractAction * - * @mixin \Spatie\SchemaOrg\Action */ -class InteractAction extends BaseType +class InteractAction extends BaseType implements ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/InteractionCounter.php b/src/InteractionCounter.php index 14aaa5492..29b65131a 100644 --- a/src/InteractionCounter.php +++ b/src/InteractionCounter.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A summary of how users have interacted with this CreativeWork. In most cases, * authors will use a subtype to specify the specific type of interaction. * * @see http://schema.org/InteractionCounter * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class InteractionCounter extends BaseType +class InteractionCounter extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The Action representing the type of interaction. For up votes, +1s, etc. @@ -28,4 +31,190 @@ public function interactionType($interactionType) return $this->setProperty('interactionType', $interactionType); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/InternetCafe.php b/src/InternetCafe.php index 9750114bb..c0eddae6e 100644 --- a/src/InternetCafe.php +++ b/src/InternetCafe.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An internet cafe. * * @see http://schema.org/InternetCafe * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class InternetCafe extends BaseType +class InternetCafe extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/InvestmentOrDeposit.php b/src/InvestmentOrDeposit.php index d24ff01a5..98d3eac42 100644 --- a/src/InvestmentOrDeposit.php +++ b/src/InvestmentOrDeposit.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A type of financial product that typically requires the client to transfer * funds to a financial service in return for potential beneficial financial @@ -9,9 +14,8 @@ * * @see http://schema.org/InvestmentOrDeposit * - * @mixin \Spatie\SchemaOrg\FinancialProduct */ -class InvestmentOrDeposit extends BaseType +class InvestmentOrDeposit extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** * The amount of money. @@ -27,4 +31,575 @@ public function amount($amount) return $this->setProperty('amount', $amount); } + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * + * @return static + * + * @see http://schema.org/interestRate + */ + public function interestRate($interestRate) + { + return $this->setProperty('interestRate', $interestRate); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/InviteAction.php b/src/InviteAction.php index 537829699..b72be363d 100644 --- a/src/InviteAction.php +++ b/src/InviteAction.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of asking someone to attend an event. Reciprocal of RsvpAction. * * @see http://schema.org/InviteAction * - * @mixin \Spatie\SchemaOrg\CommunicateAction */ -class InviteAction extends BaseType +class InviteAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** * Upcoming or past event associated with this place, organization, or @@ -26,4 +30,429 @@ public function event($event) return $this->setProperty('event', $event); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Invoice.php b/src/Invoice.php index 9fa499b95..dd631e013 100644 --- a/src/Invoice.php +++ b/src/Invoice.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A statement of the money due for goods or services; a bill. * * @see http://schema.org/Invoice * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Invoice extends BaseType +class Invoice extends BaseType implements IntangibleContract, ThingContract { /** * The identifier for the account the payment will be applied to. @@ -243,4 +245,190 @@ public function totalPaymentDue($totalPaymentDue) return $this->setProperty('totalPaymentDue', $totalPaymentDue); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ItemAvailability.php b/src/ItemAvailability.php index 8ccaf72c2..d4d040b9c 100644 --- a/src/ItemAvailability.php +++ b/src/ItemAvailability.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A list of possible product availability options. * * @see http://schema.org/ItemAvailability * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class ItemAvailability extends BaseType +class ItemAvailability extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * Indicates that the item has been discontinued. @@ -76,4 +79,190 @@ class ItemAvailability extends BaseType */ const SoldOut = 'http://schema.org/SoldOut'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ItemList.php b/src/ItemList.php index 2750f87d9..5d3c9cd39 100644 --- a/src/ItemList.php +++ b/src/ItemList.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A list of items of any sort—for example, Top 10 Movies About * Weathermen, or Top 100 Party Songs. Not to be confused with HTML lists, which @@ -9,9 +12,8 @@ * * @see http://schema.org/ItemList * - * @mixin \Spatie\SchemaOrg\Intangible */ -class ItemList extends BaseType +class ItemList extends BaseType implements IntangibleContract, ThingContract { /** * For itemListElement values, you can use simple strings (e.g. "Peter", @@ -68,4 +70,190 @@ public function numberOfItems($numberOfItems) return $this->setProperty('numberOfItems', $numberOfItems); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ItemListOrderType.php b/src/ItemListOrderType.php index e2bc52c1e..427c8552d 100644 --- a/src/ItemListOrderType.php +++ b/src/ItemListOrderType.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Enumerated for values for itemListOrder for indicating how an ordered * ItemList is organized. * * @see http://schema.org/ItemListOrderType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class ItemListOrderType extends BaseType +class ItemListOrderType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * An ItemList ordered with lower values listed first. @@ -33,4 +36,190 @@ class ItemListOrderType extends BaseType */ const ItemListUnordered = 'http://schema.org/ItemListUnordered'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ItemPage.php b/src/ItemPage.php index 47b5e0bdb..b409491f8 100644 --- a/src/ItemPage.php +++ b/src/ItemPage.php @@ -2,13 +2,1691 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A page devoted to a single item, such as a particular product or hotel. * * @see http://schema.org/ItemPage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class ItemPage extends BaseType +class ItemPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/JewelryStore.php b/src/JewelryStore.php index cfeb35048..975091d35 100644 --- a/src/JewelryStore.php +++ b/src/JewelryStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A jewelry store. * * @see http://schema.org/JewelryStore * - * @mixin \Spatie\SchemaOrg\Store */ -class JewelryStore extends BaseType +class JewelryStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/JobPosting.php b/src/JobPosting.php index 6949ee6c3..8eefec573 100644 --- a/src/JobPosting.php +++ b/src/JobPosting.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A listing that describes a job opening in a certain organization. * * @see http://schema.org/JobPosting * - * @mixin \Spatie\SchemaOrg\Intangible */ -class JobPosting extends BaseType +class JobPosting extends BaseType implements IntangibleContract, ThingContract { /** * The base salary of the job or of an employee in an EmployeeRole. @@ -353,4 +355,190 @@ public function workHours($workHours) return $this->setProperty('workHours', $workHours); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/JoinAction.php b/src/JoinAction.php index d2a2e2d4f..857b122cf 100644 --- a/src/JoinAction.php +++ b/src/JoinAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent joins an event/group with participants/friends at a location. * @@ -16,9 +20,8 @@ * * @see http://schema.org/JoinAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class JoinAction extends BaseType +class JoinAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { /** * Upcoming or past event associated with this place, organization, or @@ -35,4 +38,369 @@ public function event($event) return $this->setProperty('event', $event); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LakeBodyOfWater.php b/src/LakeBodyOfWater.php index f2775b7cf..86c5aeae5 100644 --- a/src/LakeBodyOfWater.php +++ b/src/LakeBodyOfWater.php @@ -2,13 +2,683 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BodyOfWaterContract; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A lake (for example, Lake Pontrachain). * * @see http://schema.org/LakeBodyOfWater * - * @mixin \Spatie\SchemaOrg\BodyOfWater */ -class LakeBodyOfWater extends BaseType +class LakeBodyOfWater extends BaseType implements BodyOfWaterContract, LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Landform.php b/src/Landform.php index 875858287..91f3f2731 100644 --- a/src/Landform.php +++ b/src/Landform.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A landform or physical feature. Landform elements include mountains, plains, * lakes, rivers, seascape and oceanic waterbody interface features such as @@ -10,8 +13,673 @@ * * @see http://schema.org/Landform * - * @mixin \Spatie\SchemaOrg\Place */ -class Landform extends BaseType +class Landform extends BaseType implements PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LandmarksOrHistoricalBuildings.php b/src/LandmarksOrHistoricalBuildings.php index 9726ee7b7..3cb5c1cc8 100644 --- a/src/LandmarksOrHistoricalBuildings.php +++ b/src/LandmarksOrHistoricalBuildings.php @@ -2,13 +2,681 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An historical landmark or building. * * @see http://schema.org/LandmarksOrHistoricalBuildings * - * @mixin \Spatie\SchemaOrg\Place */ -class LandmarksOrHistoricalBuildings extends BaseType +class LandmarksOrHistoricalBuildings extends BaseType implements PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Language.php b/src/Language.php index fcd1c5a41..bf2564ba9 100644 --- a/src/Language.php +++ b/src/Language.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Natural languages such as Spanish, Tamil, Hindi, English, etc. Formal * language code tags expressed in [BCP @@ -12,8 +15,193 @@ * * @see http://schema.org/Language * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Language extends BaseType +class Language extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LeaveAction.php b/src/LeaveAction.php index 76d66499b..533f84c62 100644 --- a/src/LeaveAction.php +++ b/src/LeaveAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent leaves an event / group with participants/friends at a location. * @@ -13,9 +17,8 @@ * * @see http://schema.org/LeaveAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class LeaveAction extends BaseType +class LeaveAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { /** * Upcoming or past event associated with this place, organization, or @@ -32,4 +35,369 @@ public function event($event) return $this->setProperty('event', $event); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LegalService.php b/src/LegalService.php index 935ea67ca..b4b388db5 100644 --- a/src/LegalService.php +++ b/src/LegalService.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A LegalService is a business that provides legally-oriented services, advice * and representation, e.g. law firms. @@ -11,8 +16,1328 @@ * * @see http://schema.org/LegalService * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class LegalService extends BaseType +class LegalService extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/LegislativeBuilding.php b/src/LegislativeBuilding.php index df060b8a5..d5b1362e5 100644 --- a/src/LegislativeBuilding.php +++ b/src/LegislativeBuilding.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A legislative building—for example, the state capitol. * * @see http://schema.org/LegislativeBuilding * - * @mixin \Spatie\SchemaOrg\GovernmentBuilding */ -class LegislativeBuilding extends BaseType +class LegislativeBuilding extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LendAction.php b/src/LendAction.php index 8814ce8e3..87335c3a4 100644 --- a/src/LendAction.php +++ b/src/LendAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of providing an object under an agreement that it will be returned at * a later date. Reciprocal of BorrowAction. @@ -12,9 +16,8 @@ * * @see http://schema.org/LendAction * - * @mixin \Spatie\SchemaOrg\TransferAction */ -class LendAction extends BaseType +class LendAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** * A sub property of participant. The person that borrows the object being @@ -31,4 +34,399 @@ public function borrower($borrower) return $this->setProperty('borrower', $borrower); } + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Library.php b/src/Library.php index 2b31bcd8c..abf97ed96 100644 --- a/src/Library.php +++ b/src/Library.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A library. * * @see http://schema.org/Library * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class Library extends BaseType +class Library extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/LikeAction.php b/src/LikeAction.php index 9c149be0f..f3cb252ef 100644 --- a/src/LikeAction.php +++ b/src/LikeAction.php @@ -2,14 +2,383 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of expressing a positive sentiment about the object. An agent likes * an object (a proposition, topic or theme) with participants. * * @see http://schema.org/LikeAction * - * @mixin \Spatie\SchemaOrg\ReactAction */ -class LikeAction extends BaseType +class LikeAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LiquorStore.php b/src/LiquorStore.php index 7eaadcc7e..0bbc4e9ce 100644 --- a/src/LiquorStore.php +++ b/src/LiquorStore.php @@ -2,14 +2,1340 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A shop that sells alcoholic drinks such as wine, beer, whisky and other * spirits. * * @see http://schema.org/LiquorStore * - * @mixin \Spatie\SchemaOrg\Store */ -class LiquorStore extends BaseType +class LiquorStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ListItem.php b/src/ListItem.php index b864594f7..c38f632af 100644 --- a/src/ListItem.php +++ b/src/ListItem.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An list item, e.g. a step in a checklist or how-to description. * * @see http://schema.org/ListItem * - * @mixin \Spatie\SchemaOrg\Intangible */ -class ListItem extends BaseType +class ListItem extends BaseType implements IntangibleContract, ThingContract { /** * An entity represented by an entry in a list or data feed (e.g. an @@ -68,4 +70,190 @@ public function previousItem($previousItem) return $this->setProperty('previousItem', $previousItem); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ListenAction.php b/src/ListenAction.php index 1659c05b2..01513e34a 100644 --- a/src/ListenAction.php +++ b/src/ListenAction.php @@ -2,13 +2,413 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of consuming audio content. * * @see http://schema.org/ListenAction * - * @mixin \Spatie\SchemaOrg\ConsumeAction */ -class ListenAction extends BaseType +class ListenAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LiteraryEvent.php b/src/LiteraryEvent.php index 6fda74991..070e213ac 100644 --- a/src/LiteraryEvent.php +++ b/src/LiteraryEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Literary event. * * @see http://schema.org/LiteraryEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class LiteraryEvent extends BaseType +class LiteraryEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LiveBlogPosting.php b/src/LiveBlogPosting.php index a73f4193e..17bc8c089 100644 --- a/src/LiveBlogPosting.php +++ b/src/LiveBlogPosting.php @@ -2,15 +2,20 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BlogPostingContract; +use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A blog post intended to provide a rolling textual coverage of an ongoing * event through continuous updates. * * @see http://schema.org/LiveBlogPosting * - * @mixin \Spatie\SchemaOrg\BlogPosting */ -class LiveBlogPosting extends BaseType +class LiveBlogPosting extends BaseType implements BlogPostingContract, SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract { /** * The time when the live blog will stop covering the Event. Note that @@ -57,4 +62,1649 @@ public function liveBlogUpdate($liveBlogUpdate) return $this->setProperty('liveBlogUpdate', $liveBlogUpdate); } + /** + * A CreativeWork such as an image, video, or audio clip shared as part of + * this posting. + * + * @param CreativeWork|CreativeWork[] $sharedContent + * + * @return static + * + * @see http://schema.org/sharedContent + */ + public function sharedContent($sharedContent) + { + return $this->setProperty('sharedContent', $sharedContent); + } + + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LoanOrCredit.php b/src/LoanOrCredit.php index 371ea830a..03dc359d0 100644 --- a/src/LoanOrCredit.php +++ b/src/LoanOrCredit.php @@ -2,15 +2,19 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A financial product for the loaning of an amount of money under agreed terms * and charges. * * @see http://schema.org/LoanOrCredit * - * @mixin \Spatie\SchemaOrg\FinancialProduct */ -class LoanOrCredit extends BaseType +class LoanOrCredit extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** * The amount of money. @@ -55,4 +59,575 @@ public function requiredCollateral($requiredCollateral) return $this->setProperty('requiredCollateral', $requiredCollateral); } + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * + * @return static + * + * @see http://schema.org/interestRate + */ + public function interestRate($interestRate) + { + return $this->setProperty('interestRate', $interestRate); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LocalBusiness.php b/src/LocalBusiness.php index 3ab5c5343..226387577 100644 --- a/src/LocalBusiness.php +++ b/src/LocalBusiness.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A particular physical business or branch of an organization. Examples of * LocalBusiness include a restaurant, a particular branch of a restaurant @@ -9,10 +13,8 @@ * * @see http://schema.org/LocalBusiness * - * @mixin \Spatie\SchemaOrg\Organization - * @mixin \Spatie\SchemaOrg\Place */ -class LocalBusiness extends BaseType +class LocalBusiness extends BaseType implements OrganizationContract, PlaceContract, ThingContract { /** * The larger organization that this local business is a branch of, if any. @@ -108,4 +110,1231 @@ public function priceRange($priceRange) return $this->setProperty('priceRange', $priceRange); } + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/LocationFeatureSpecification.php b/src/LocationFeatureSpecification.php index dfdd15942..c2a2b2aee 100644 --- a/src/LocationFeatureSpecification.php +++ b/src/LocationFeatureSpecification.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PropertyValueContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Specifies a location feature by providing a structured value representing a * feature of an accommodation as a property-value pair of varying degrees of @@ -9,9 +14,8 @@ * * @see http://schema.org/LocationFeatureSpecification * - * @mixin \Spatie\SchemaOrg\PropertyValue */ -class LocationFeatureSpecification extends BaseType +class LocationFeatureSpecification extends BaseType implements PropertyValueContract, StructuredValueContract, IntangibleContract, ThingContract { /** * The hours during which this service or contact is available. @@ -56,4 +60,312 @@ public function validThrough($validThrough) return $this->setProperty('validThrough', $validThrough); } + /** + * The upper value of some characteristic or property. + * + * @param float|float[]|int|int[] $maxValue + * + * @return static + * + * @see http://schema.org/maxValue + */ + public function maxValue($maxValue) + { + return $this->setProperty('maxValue', $maxValue); + } + + /** + * The lower value of some characteristic or property. + * + * @param float|float[]|int|int[] $minValue + * + * @return static + * + * @see http://schema.org/minValue + */ + public function minValue($minValue) + { + return $this->setProperty('minValue', $minValue); + } + + /** + * A commonly used identifier for the characteristic represented by the + * property, e.g. a manufacturer or a standard code for a property. + * propertyID can be + * (1) a prefixed string, mainly meant to be used with standards for product + * properties; (2) a site-specific, non-prefixed string (e.g. the primary + * key of the property or the vendor-specific id of the property), or (3) + * a URL indicating the type of the property, either pointing to an external + * vocabulary, or a Web resource that describes the property (e.g. a + * glossary entry). + * Standards bodies should promote a standard prefix for the identifiers of + * properties from their standards. + * + * @param string|string[] $propertyID + * + * @return static + * + * @see http://schema.org/propertyID + */ + public function propertyID($propertyID) + { + return $this->setProperty('propertyID', $propertyID); + } + + /** + * The unit of measurement given using the UN/CEFACT Common Code (3 + * characters) or a URL. Other codes than the UN/CEFACT Common Code may be + * used with a prefix followed by a colon. + * + * @param string|string[] $unitCode + * + * @return static + * + * @see http://schema.org/unitCode + */ + public function unitCode($unitCode) + { + return $this->setProperty('unitCode', $unitCode); + } + + /** + * A string or text indicating the unit of measurement. Useful if you cannot + * provide a standard unit code for + * unitCode. + * + * @param string|string[] $unitText + * + * @return static + * + * @see http://schema.org/unitText + */ + public function unitText($unitText) + { + return $this->setProperty('unitText', $unitText); + } + + /** + * The value of the quantitative value or property value node. + * + * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type + * for values is 'Number'. + * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or + * 'StructuredValue'. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value + * + * @return static + * + * @see http://schema.org/value + */ + public function value($value) + { + return $this->setProperty('value', $value); + } + + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LockerDelivery.php b/src/LockerDelivery.php index 6abc0a904..663fb0503 100644 --- a/src/LockerDelivery.php +++ b/src/LockerDelivery.php @@ -2,13 +2,203 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\DeliveryMethodContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A DeliveryMethod in which an item is made available via locker. * * @see http://schema.org/LockerDelivery * - * @mixin \Spatie\SchemaOrg\DeliveryMethod */ -class LockerDelivery extends BaseType +class LockerDelivery extends BaseType implements DeliveryMethodContract, EnumerationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Locksmith.php b/src/Locksmith.php index 1268c1c03..08e1afe91 100644 --- a/src/Locksmith.php +++ b/src/Locksmith.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HomeAndConstructionBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A locksmith. * * @see http://schema.org/Locksmith * - * @mixin \Spatie\SchemaOrg\HomeAndConstructionBusiness */ -class Locksmith extends BaseType +class Locksmith extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/LodgingBusiness.php b/src/LodgingBusiness.php index 42ae0a8c8..5e3b45783 100644 --- a/src/LodgingBusiness.php +++ b/src/LodgingBusiness.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A lodging business, such as a motel, hotel, or inn. * * @see http://schema.org/LodgingBusiness * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class LodgingBusiness extends BaseType +class LodgingBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * An amenity feature (e.g. a characteristic or service) of the @@ -135,4 +139,1325 @@ public function starRating($starRating) return $this->setProperty('starRating', $starRating); } + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/LodgingReservation.php b/src/LodgingReservation.php index cf37477d2..19ecf7045 100644 --- a/src/LodgingReservation.php +++ b/src/LodgingReservation.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservation for lodging at a hotel, motel, inn, etc. * @@ -11,9 +15,8 @@ * * @see http://schema.org/LodgingReservation * - * @mixin \Spatie\SchemaOrg\Reservation */ -class LodgingReservation extends BaseType +class LodgingReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** * The earliest someone may check into a lodging establishment. @@ -100,4 +103,396 @@ public function numChildren($numChildren) return $this->setProperty('numChildren', $numChildren); } + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/LoseAction.php b/src/LoseAction.php index 457bde227..3b5b830dd 100644 --- a/src/LoseAction.php +++ b/src/LoseAction.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AchieveActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of being defeated in a competitive activity. * * @see http://schema.org/LoseAction * - * @mixin \Spatie\SchemaOrg\AchieveAction */ -class LoseAction extends BaseType +class LoseAction extends BaseType implements AchieveActionContract, ActionContract, ThingContract { /** * A sub property of participant. The winner of the action. @@ -25,4 +28,369 @@ public function winner($winner) return $this->setProperty('winner', $winner); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Map.php b/src/Map.php index c74a1a99a..edefcd1b7 100644 --- a/src/Map.php +++ b/src/Map.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A map. * * @see http://schema.org/Map * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Map extends BaseType +class Map extends BaseType implements CreativeWorkContract, ThingContract { /** * Indicates the kind of Map, from the MapCategoryType Enumeration. @@ -25,4 +27,1509 @@ public function mapType($mapType) return $this->setProperty('mapType', $mapType); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MapCategoryType.php b/src/MapCategoryType.php index a5ae19a80..026d7ba60 100644 --- a/src/MapCategoryType.php +++ b/src/MapCategoryType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An enumeration of several kinds of Map. * * @see http://schema.org/MapCategoryType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class MapCategoryType extends BaseType +class MapCategoryType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * A parking map. @@ -39,4 +42,190 @@ class MapCategoryType extends BaseType */ const VenueMap = 'http://schema.org/VenueMap'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MarryAction.php b/src/MarryAction.php index a3c98e8e6..3ada4a894 100644 --- a/src/MarryAction.php +++ b/src/MarryAction.php @@ -2,13 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of marrying a person. * * @see http://schema.org/MarryAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class MarryAction extends BaseType +class MarryAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Mass.php b/src/Mass.php index 3e41a5c38..f2aadde96 100644 --- a/src/Mass.php +++ b/src/Mass.php @@ -2,14 +2,203 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\QuantityContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Properties that take Mass as values are of the form '<Number> <Mass * unit of measure>'. E.g., '7 kg'. * * @see http://schema.org/Mass * - * @mixin \Spatie\SchemaOrg\Quantity */ -class Mass extends BaseType +class Mass extends BaseType implements QuantityContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MediaObject.php b/src/MediaObject.php index bceae40e5..9966ba4c0 100644 --- a/src/MediaObject.php +++ b/src/MediaObject.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A media object, such as an image, video, or audio object embedded in a web * page or a downloadable dataset i.e. DataDownload. Note that a creative work @@ -11,9 +14,8 @@ * * @see http://schema.org/MediaObject * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class MediaObject extends BaseType +class MediaObject extends BaseType implements CreativeWorkContract, ThingContract { /** * A NewsArticle associated with the Media Object. @@ -293,4 +295,1509 @@ public function width($width) return $this->setProperty('width', $width); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MediaSubscription.php b/src/MediaSubscription.php index d93aa82df..56708859c 100644 --- a/src/MediaSubscription.php +++ b/src/MediaSubscription.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A subscription which allows a user to access media including audio, video, * books, etc. * * @see http://schema.org/MediaSubscription * - * @mixin \Spatie\SchemaOrg\Intangible */ -class MediaSubscription extends BaseType +class MediaSubscription extends BaseType implements IntangibleContract, ThingContract { /** * The Organization responsible for authenticating the user's subscription. @@ -42,4 +44,190 @@ public function expectsAcceptanceOf($expectsAcceptanceOf) return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MedicalOrganization.php b/src/MedicalOrganization.php index a77fa0cfe..d233bf1b3 100644 --- a/src/MedicalOrganization.php +++ b/src/MedicalOrganization.php @@ -2,14 +2,938 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A medical organization (physical or not), such as hospital, institution or * clinic. * * @see http://schema.org/MedicalOrganization * - * @mixin \Spatie\SchemaOrg\Organization */ -class MedicalOrganization extends BaseType +class MedicalOrganization extends BaseType implements OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MeetingRoom.php b/src/MeetingRoom.php index f78515d46..aaa7374f7 100644 --- a/src/MeetingRoom.php +++ b/src/MeetingRoom.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\RoomContract; +use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A meeting room, conference room, or conference hall is a room provided for * singular events such as business conferences and meetings (Source: Wikipedia, @@ -13,8 +18,735 @@ * * @see http://schema.org/MeetingRoom * - * @mixin \Spatie\SchemaOrg\Room */ -class MeetingRoom extends BaseType +class MeetingRoom extends BaseType implements RoomContract, AccommodationContract, PlaceContract, ThingContract { + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indications regarding the permitted usage of the accommodation. + * + * @param string|string[] $permittedUsage + * + * @return static + * + * @see http://schema.org/permittedUsage + */ + public function permittedUsage($permittedUsage) + { + return $this->setProperty('permittedUsage', $permittedUsage); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MensClothingStore.php b/src/MensClothingStore.php index 8e7931ffd..b86fb51e1 100644 --- a/src/MensClothingStore.php +++ b/src/MensClothingStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A men's clothing store. * * @see http://schema.org/MensClothingStore * - * @mixin \Spatie\SchemaOrg\Store */ -class MensClothingStore extends BaseType +class MensClothingStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Menu.php b/src/Menu.php index 77c4de713..43e8da4a7 100644 --- a/src/Menu.php +++ b/src/Menu.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A structured representation of food or drink items available from a * FoodEstablishment. * * @see http://schema.org/Menu * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Menu extends BaseType +class Menu extends BaseType implements CreativeWorkContract, ThingContract { /** * A food or drink item contained in a menu or menu section. @@ -40,4 +42,1509 @@ public function hasMenuSection($hasMenuSection) return $this->setProperty('hasMenuSection', $hasMenuSection); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MenuItem.php b/src/MenuItem.php index 3c7df3639..1c40b6090 100644 --- a/src/MenuItem.php +++ b/src/MenuItem.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A food or drink item listed in a menu or menu section. * * @see http://schema.org/MenuItem * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class MenuItem extends BaseType +class MenuItem extends BaseType implements CreativeWorkContract, ThingContract { /** * Additional menu item(s) such as a side dish of salad or side order of @@ -72,4 +74,1509 @@ public function suitableForDiet($suitableForDiet) return $this->setProperty('suitableForDiet', $suitableForDiet); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MenuSection.php b/src/MenuSection.php index a14d082d7..969a0e41f 100644 --- a/src/MenuSection.php +++ b/src/MenuSection.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A sub-grouping of food or drink items in a menu. E.g. courses (such as * 'Dinner', 'Breakfast', etc.), specific type of dishes (such as 'Meat', @@ -10,9 +13,8 @@ * * @see http://schema.org/MenuSection * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class MenuSection extends BaseType +class MenuSection extends BaseType implements CreativeWorkContract, ThingContract { /** * A food or drink item contained in a menu or menu section. @@ -42,4 +44,1509 @@ public function hasMenuSection($hasMenuSection) return $this->setProperty('hasMenuSection', $hasMenuSection); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Message.php b/src/Message.php index 93baf8b2d..b144c314d 100644 --- a/src/Message.php +++ b/src/Message.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A single message from a sender to one or more organizations or people. * * @see http://schema.org/Message * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Message extends BaseType +class Message extends BaseType implements CreativeWorkContract, ThingContract { /** * A sub property of recipient. The recipient blind copied on a message. @@ -141,4 +143,1509 @@ public function toRecipient($toRecipient) return $this->setProperty('toRecipient', $toRecipient); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MiddleSchool.php b/src/MiddleSchool.php index b85bbccaf..8f07f1e19 100644 --- a/src/MiddleSchool.php +++ b/src/MiddleSchool.php @@ -2,14 +2,953 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EducationalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A middle school (typically for children aged around 11-14, although this * varies somewhat). * * @see http://schema.org/MiddleSchool * - * @mixin \Spatie\SchemaOrg\EducationalOrganization */ -class MiddleSchool extends BaseType +class MiddleSchool extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MobileApplication.php b/src/MobileApplication.php index 82d257e22..02fc2c2e9 100644 --- a/src/MobileApplication.php +++ b/src/MobileApplication.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A software application designed specifically to work well on a mobile device * such as a telephone. * * @see http://schema.org/MobileApplication * - * @mixin \Spatie\SchemaOrg\SoftwareApplication */ -class MobileApplication extends BaseType +class MobileApplication extends BaseType implements SoftwareApplicationContract, CreativeWorkContract, ThingContract { /** * Specifies specific carrier(s) requirements for the application (e.g. an @@ -27,4 +30,1860 @@ public function carrierRequirements($carrierRequirements) return $this->setProperty('carrierRequirements', $carrierRequirements); } + /** + * Type of software application, e.g. 'Game, Multimedia'. + * + * @param string|string[] $applicationCategory + * + * @return static + * + * @see http://schema.org/applicationCategory + */ + public function applicationCategory($applicationCategory) + { + return $this->setProperty('applicationCategory', $applicationCategory); + } + + /** + * Subcategory of the application, e.g. 'Arcade Game'. + * + * @param string|string[] $applicationSubCategory + * + * @return static + * + * @see http://schema.org/applicationSubCategory + */ + public function applicationSubCategory($applicationSubCategory) + { + return $this->setProperty('applicationSubCategory', $applicationSubCategory); + } + + /** + * The name of the application suite to which the application belongs (e.g. + * Excel belongs to Office). + * + * @param string|string[] $applicationSuite + * + * @return static + * + * @see http://schema.org/applicationSuite + */ + public function applicationSuite($applicationSuite) + { + return $this->setProperty('applicationSuite', $applicationSuite); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $availableOnDevice + * + * @return static + * + * @see http://schema.org/availableOnDevice + */ + public function availableOnDevice($availableOnDevice) + { + return $this->setProperty('availableOnDevice', $availableOnDevice); + } + + /** + * Countries for which the application is not supported. You can also + * provide the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesNotSupported + * + * @return static + * + * @see http://schema.org/countriesNotSupported + */ + public function countriesNotSupported($countriesNotSupported) + { + return $this->setProperty('countriesNotSupported', $countriesNotSupported); + } + + /** + * Countries for which the application is supported. You can also provide + * the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesSupported + * + * @return static + * + * @see http://schema.org/countriesSupported + */ + public function countriesSupported($countriesSupported) + { + return $this->setProperty('countriesSupported', $countriesSupported); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $device + * + * @return static + * + * @see http://schema.org/device + */ + public function device($device) + { + return $this->setProperty('device', $device); + } + + /** + * If the file can be downloaded, URL to download the binary. + * + * @param string|string[] $downloadUrl + * + * @return static + * + * @see http://schema.org/downloadUrl + */ + public function downloadUrl($downloadUrl) + { + return $this->setProperty('downloadUrl', $downloadUrl); + } + + /** + * Features or modules provided by this application (and possibly required + * by other applications). + * + * @param string|string[] $featureList + * + * @return static + * + * @see http://schema.org/featureList + */ + public function featureList($featureList) + { + return $this->setProperty('featureList', $featureList); + } + + /** + * Size of the application / package (e.g. 18MB). In the absence of a unit + * (MB, KB etc.), KB will be assumed. + * + * @param string|string[] $fileSize + * + * @return static + * + * @see http://schema.org/fileSize + */ + public function fileSize($fileSize) + { + return $this->setProperty('fileSize', $fileSize); + } + + /** + * URL at which the app may be installed, if different from the URL of the + * item. + * + * @param string|string[] $installUrl + * + * @return static + * + * @see http://schema.org/installUrl + */ + public function installUrl($installUrl) + { + return $this->setProperty('installUrl', $installUrl); + } + + /** + * Minimum memory requirements. + * + * @param string|string[] $memoryRequirements + * + * @return static + * + * @see http://schema.org/memoryRequirements + */ + public function memoryRequirements($memoryRequirements) + { + return $this->setProperty('memoryRequirements', $memoryRequirements); + } + + /** + * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). + * + * @param string|string[] $operatingSystem + * + * @return static + * + * @see http://schema.org/operatingSystem + */ + public function operatingSystem($operatingSystem) + { + return $this->setProperty('operatingSystem', $operatingSystem); + } + + /** + * Permission(s) required to run the app (for example, a mobile app may + * require full internet access or may run only on wifi). + * + * @param string|string[] $permissions + * + * @return static + * + * @see http://schema.org/permissions + */ + public function permissions($permissions) + { + return $this->setProperty('permissions', $permissions); + } + + /** + * Processor architecture required to run the application (e.g. IA64). + * + * @param string|string[] $processorRequirements + * + * @return static + * + * @see http://schema.org/processorRequirements + */ + public function processorRequirements($processorRequirements) + { + return $this->setProperty('processorRequirements', $processorRequirements); + } + + /** + * Description of what changed in this version. + * + * @param string|string[] $releaseNotes + * + * @return static + * + * @see http://schema.org/releaseNotes + */ + public function releaseNotes($releaseNotes) + { + return $this->setProperty('releaseNotes', $releaseNotes); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $requirements + * + * @return static + * + * @see http://schema.org/requirements + */ + public function requirements($requirements) + { + return $this->setProperty('requirements', $requirements); + } + + /** + * A link to a screenshot image of the app. + * + * @param ImageObject|ImageObject[]|string|string[] $screenshot + * + * @return static + * + * @see http://schema.org/screenshot + */ + public function screenshot($screenshot) + { + return $this->setProperty('screenshot', $screenshot); + } + + /** + * Additional content for a software application. + * + * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn + * + * @return static + * + * @see http://schema.org/softwareAddOn + */ + public function softwareAddOn($softwareAddOn) + { + return $this->setProperty('softwareAddOn', $softwareAddOn); + } + + /** + * Software application help. + * + * @param CreativeWork|CreativeWork[] $softwareHelp + * + * @return static + * + * @see http://schema.org/softwareHelp + */ + public function softwareHelp($softwareHelp) + { + return $this->setProperty('softwareHelp', $softwareHelp); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $softwareRequirements + * + * @return static + * + * @see http://schema.org/softwareRequirements + */ + public function softwareRequirements($softwareRequirements) + { + return $this->setProperty('softwareRequirements', $softwareRequirements); + } + + /** + * Version of the software instance. + * + * @param string|string[] $softwareVersion + * + * @return static + * + * @see http://schema.org/softwareVersion + */ + public function softwareVersion($softwareVersion) + { + return $this->setProperty('softwareVersion', $softwareVersion); + } + + /** + * Storage requirements (free space required). + * + * @param string|string[] $storageRequirements + * + * @return static + * + * @see http://schema.org/storageRequirements + */ + public function storageRequirements($storageRequirements) + { + return $this->setProperty('storageRequirements', $storageRequirements); + } + + /** + * Supporting data for a SoftwareApplication. + * + * @param DataFeed|DataFeed[] $supportingData + * + * @return static + * + * @see http://schema.org/supportingData + */ + public function supportingData($supportingData) + { + return $this->setProperty('supportingData', $supportingData); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MobilePhoneStore.php b/src/MobilePhoneStore.php index 3cd066877..ef236ba5d 100644 --- a/src/MobilePhoneStore.php +++ b/src/MobilePhoneStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A store that sells mobile phones and related accessories. * * @see http://schema.org/MobilePhoneStore * - * @mixin \Spatie\SchemaOrg\Store */ -class MobilePhoneStore extends BaseType +class MobilePhoneStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/MonetaryAmount.php b/src/MonetaryAmount.php index 37132d169..deffc93da 100644 --- a/src/MonetaryAmount.php +++ b/src/MonetaryAmount.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A monetary value or range. This type can be used to describe an amount of * money such as $50 USD, or a range as in describing a bank account being @@ -11,9 +15,8 @@ * * @see http://schema.org/MonetaryAmount * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class MonetaryAmount extends BaseType +class MonetaryAmount extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The currency in which the monetary amount is expressed. @@ -88,4 +91,190 @@ public function value($value) return $this->setProperty('value', $value); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MonetaryAmountDistribution.php b/src/MonetaryAmountDistribution.php index 0943b8e5c..f5e3afe47 100644 --- a/src/MonetaryAmountDistribution.php +++ b/src/MonetaryAmountDistribution.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\QuantitativeValueDistributionContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A statistical distribution of monetary amounts. * * @see http://schema.org/MonetaryAmountDistribution * - * @mixin \Spatie\SchemaOrg\QuantitativeValueDistribution */ -class MonetaryAmountDistribution extends BaseType +class MonetaryAmountDistribution extends BaseType implements QuantitativeValueDistributionContract, StructuredValueContract, IntangibleContract, ThingContract { /** * The currency in which the monetary amount is expressed. @@ -33,4 +37,260 @@ public function currency($currency) return $this->setProperty('currency', $currency); } + /** + * The median value. + * + * @param float|float[]|int|int[] $median + * + * @return static + * + * @see http://schema.org/median + */ + public function median($median) + { + return $this->setProperty('median', $median); + } + + /** + * The 10th percentile value. + * + * @param float|float[]|int|int[] $percentile10 + * + * @return static + * + * @see http://schema.org/percentile10 + */ + public function percentile10($percentile10) + { + return $this->setProperty('percentile10', $percentile10); + } + + /** + * The 25th percentile value. + * + * @param float|float[]|int|int[] $percentile25 + * + * @return static + * + * @see http://schema.org/percentile25 + */ + public function percentile25($percentile25) + { + return $this->setProperty('percentile25', $percentile25); + } + + /** + * The 75th percentile value. + * + * @param float|float[]|int|int[] $percentile75 + * + * @return static + * + * @see http://schema.org/percentile75 + */ + public function percentile75($percentile75) + { + return $this->setProperty('percentile75', $percentile75); + } + + /** + * The 90th percentile value. + * + * @param float|float[]|int|int[] $percentile90 + * + * @return static + * + * @see http://schema.org/percentile90 + */ + public function percentile90($percentile90) + { + return $this->setProperty('percentile90', $percentile90); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Mosque.php b/src/Mosque.php index 6deb74260..745abb7f7 100644 --- a/src/Mosque.php +++ b/src/Mosque.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A mosque. * * @see http://schema.org/Mosque * - * @mixin \Spatie\SchemaOrg\PlaceOfWorship */ -class Mosque extends BaseType +class Mosque extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Motel.php b/src/Motel.php index d86ba6967..8ef993330 100644 --- a/src/Motel.php +++ b/src/Motel.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A motel. * @@ -10,8 +16,1435 @@ * * @see http://schema.org/Motel * - * @mixin \Spatie\SchemaOrg\LodgingBusiness */ -class Motel extends BaseType +class Motel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * + * @param Language|Language[]|string|string[] $availableLanguage + * + * @return static + * + * @see http://schema.org/availableLanguage + */ + public function availableLanguage($availableLanguage) + { + return $this->setProperty('availableLanguage', $availableLanguage); + } + + /** + * The earliest someone may check into a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * + * @return static + * + * @see http://schema.org/checkinTime + */ + public function checkinTime($checkinTime) + { + return $this->setProperty('checkinTime', $checkinTime); + } + + /** + * The latest someone may check out of a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * + * @return static + * + * @see http://schema.org/checkoutTime + */ + public function checkoutTime($checkoutTime) + { + return $this->setProperty('checkoutTime', $checkoutTime); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/MotorcycleDealer.php b/src/MotorcycleDealer.php index c1576ff0f..cdce18db9 100644 --- a/src/MotorcycleDealer.php +++ b/src/MotorcycleDealer.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A motorcycle dealer. * * @see http://schema.org/MotorcycleDealer * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness */ -class MotorcycleDealer extends BaseType +class MotorcycleDealer extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/MotorcycleRepair.php b/src/MotorcycleRepair.php index 2c121739f..51c290cb4 100644 --- a/src/MotorcycleRepair.php +++ b/src/MotorcycleRepair.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A motorcycle repair shop. * * @see http://schema.org/MotorcycleRepair * - * @mixin \Spatie\SchemaOrg\AutomotiveBusiness */ -class MotorcycleRepair extends BaseType +class MotorcycleRepair extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Mountain.php b/src/Mountain.php index 4d4a3d854..176b5b18b 100644 --- a/src/Mountain.php +++ b/src/Mountain.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A mountain, like Mount Whitney or Mount Everest. * * @see http://schema.org/Mountain * - * @mixin \Spatie\SchemaOrg\Landform */ -class Mountain extends BaseType +class Mountain extends BaseType implements LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MoveAction.php b/src/MoveAction.php index bfa60b008..749828766 100644 --- a/src/MoveAction.php +++ b/src/MoveAction.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of an agent relocating to a place. * @@ -12,9 +15,8 @@ * * @see http://schema.org/MoveAction * - * @mixin \Spatie\SchemaOrg\Action */ -class MoveAction extends BaseType +class MoveAction extends BaseType implements ActionContract, ThingContract { /** * A sub property of location. The original location of the object or the @@ -46,4 +48,369 @@ public function toLocation($toLocation) return $this->setProperty('toLocation', $toLocation); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Movie.php b/src/Movie.php index 434936da3..d26aeb5d9 100644 --- a/src/Movie.php +++ b/src/Movie.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A movie. * * @see http://schema.org/Movie * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Movie extends BaseType +class Movie extends BaseType implements CreativeWorkContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -161,4 +163,1509 @@ public function trailer($trailer) return $this->setProperty('trailer', $trailer); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MovieClip.php b/src/MovieClip.php index 5e8dc0539..5815a147d 100644 --- a/src/MovieClip.php +++ b/src/MovieClip.php @@ -2,13 +2,1653 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ClipContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A short segment/part of a movie. * * @see http://schema.org/MovieClip * - * @mixin \Spatie\SchemaOrg\Clip */ -class MovieClip extends BaseType +class MovieClip extends BaseType implements ClipContract, CreativeWorkContract, ThingContract { + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MovieRentalStore.php b/src/MovieRentalStore.php index 05c0c5522..476465f45 100644 --- a/src/MovieRentalStore.php +++ b/src/MovieRentalStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A movie rental store. * * @see http://schema.org/MovieRentalStore * - * @mixin \Spatie\SchemaOrg\Store */ -class MovieRentalStore extends BaseType +class MovieRentalStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/MovieSeries.php b/src/MovieSeries.php index 7a2e642ee..da8ffc70f 100644 --- a/src/MovieSeries.php +++ b/src/MovieSeries.php @@ -2,15 +2,20 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A series of movies. Included movies can be indicated with the hasPart * property. * * @see http://schema.org/MovieSeries * - * @mixin \Spatie\SchemaOrg\CreativeWorkSeries */ -class MovieSeries extends BaseType +class MovieSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -101,4 +106,1571 @@ public function trailer($trailer) return $this->setProperty('trailer', $trailer); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + } diff --git a/src/MovieTheater.php b/src/MovieTheater.php index 221c88c35..e8703e4a0 100644 --- a/src/MovieTheater.php +++ b/src/MovieTheater.php @@ -2,15 +2,20 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A movie theater. * * @see http://schema.org/MovieTheater * - * @mixin \Spatie\SchemaOrg\CivicStructure - * @mixin \Spatie\SchemaOrg\EntertainmentBusiness */ -class MovieTheater extends BaseType +class MovieTheater extends BaseType implements CivicStructureContract, EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * The number of screens in the movie theater. @@ -26,4 +31,1325 @@ public function screenCount($screenCount) return $this->setProperty('screenCount', $screenCount); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + } diff --git a/src/MovingCompany.php b/src/MovingCompany.php index 3504bd011..197fec8e8 100644 --- a/src/MovingCompany.php +++ b/src/MovingCompany.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HomeAndConstructionBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A moving company. * * @see http://schema.org/MovingCompany * - * @mixin \Spatie\SchemaOrg\HomeAndConstructionBusiness */ -class MovingCompany extends BaseType +class MovingCompany extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Museum.php b/src/Museum.php index 8eddf9982..64dbde6e4 100644 --- a/src/Museum.php +++ b/src/Museum.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A museum. * * @see http://schema.org/Museum * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Museum extends BaseType +class Museum extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicAlbum.php b/src/MusicAlbum.php index eab7a0d7f..a6e06634a 100644 --- a/src/MusicAlbum.php +++ b/src/MusicAlbum.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MusicPlaylistContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A collection of music tracks. * * @see http://schema.org/MusicAlbum * - * @mixin \Spatie\SchemaOrg\MusicPlaylist */ -class MusicAlbum extends BaseType +class MusicAlbum extends BaseType implements MusicPlaylistContract, CreativeWorkContract, ThingContract { /** * Classification of the album by it's type of content: soundtrack, live @@ -68,4 +71,1552 @@ public function byArtist($byArtist) return $this->setProperty('byArtist', $byArtist); } + /** + * The number of tracks in this album or playlist. + * + * @param int|int[] $numTracks + * + * @return static + * + * @see http://schema.org/numTracks + */ + public function numTracks($numTracks) + { + return $this->setProperty('numTracks', $numTracks); + } + + /** + * A music recording (track)—usually a single song. If an ItemList is + * given, the list should contain items of type MusicRecording. + * + * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track + * + * @return static + * + * @see http://schema.org/track + */ + public function track($track) + { + return $this->setProperty('track', $track); + } + + /** + * A music recording (track)—usually a single song. + * + * @param MusicRecording|MusicRecording[] $tracks + * + * @return static + * + * @see http://schema.org/tracks + */ + public function tracks($tracks) + { + return $this->setProperty('tracks', $tracks); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicAlbumProductionType.php b/src/MusicAlbumProductionType.php index 31efc1a26..4e3e0a65c 100644 --- a/src/MusicAlbumProductionType.php +++ b/src/MusicAlbumProductionType.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Classification of the album by it's type of content: soundtrack, live album, * studio album, etc. * * @see http://schema.org/MusicAlbumProductionType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class MusicAlbumProductionType extends BaseType +class MusicAlbumProductionType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * CompilationAlbum. @@ -75,4 +78,190 @@ class MusicAlbumProductionType extends BaseType */ const StudioAlbum = 'http://schema.org/StudioAlbum'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicAlbumReleaseType.php b/src/MusicAlbumReleaseType.php index 505d9652d..f7c1395d9 100644 --- a/src/MusicAlbumReleaseType.php +++ b/src/MusicAlbumReleaseType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The kind of release which this album is: single, EP or album. * * @see http://schema.org/MusicAlbumReleaseType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class MusicAlbumReleaseType extends BaseType +class MusicAlbumReleaseType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * AlbumRelease. @@ -39,4 +42,190 @@ class MusicAlbumReleaseType extends BaseType */ const SingleRelease = 'http://schema.org/SingleRelease'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicComposition.php b/src/MusicComposition.php index 61f814a03..f6194eaa4 100644 --- a/src/MusicComposition.php +++ b/src/MusicComposition.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A musical composition. * * @see http://schema.org/MusicComposition * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class MusicComposition extends BaseType +class MusicComposition extends BaseType implements CreativeWorkContract, ThingContract { /** * The person or organization who wrote a composition, or who is the @@ -153,4 +155,1509 @@ public function recordedAs($recordedAs) return $this->setProperty('recordedAs', $recordedAs); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicEvent.php b/src/MusicEvent.php index 73999d769..740d48512 100644 --- a/src/MusicEvent.php +++ b/src/MusicEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Music event. * * @see http://schema.org/MusicEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class MusicEvent extends BaseType +class MusicEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicGroup.php b/src/MusicGroup.php index 57e3d22e6..d37bc47ad 100644 --- a/src/MusicGroup.php +++ b/src/MusicGroup.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A musical group, such as a band, an orchestra, or a choir. Can also be a solo * musician. * * @see http://schema.org/MusicGroup * - * @mixin \Spatie\SchemaOrg\PerformingGroup */ -class MusicGroup extends BaseType +class MusicGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract { /** * A music album. @@ -98,4 +101,926 @@ public function tracks($tracks) return $this->setProperty('tracks', $tracks); } + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicPlaylist.php b/src/MusicPlaylist.php index 0fd5d0f81..fcca0e358 100644 --- a/src/MusicPlaylist.php +++ b/src/MusicPlaylist.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A collection of music tracks in playlist form. * * @see http://schema.org/MusicPlaylist * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class MusicPlaylist extends BaseType +class MusicPlaylist extends BaseType implements CreativeWorkContract, ThingContract { /** * The number of tracks in this album or playlist. @@ -54,4 +56,1509 @@ public function tracks($tracks) return $this->setProperty('tracks', $tracks); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicRecording.php b/src/MusicRecording.php index b69da4934..715bbedff 100644 --- a/src/MusicRecording.php +++ b/src/MusicRecording.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A music recording (track), usually a single song. * * @see http://schema.org/MusicRecording * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class MusicRecording extends BaseType +class MusicRecording extends BaseType implements CreativeWorkContract, ThingContract { /** * The artist that performed this album or recording. @@ -96,4 +98,1509 @@ public function recordingOf($recordingOf) return $this->setProperty('recordingOf', $recordingOf); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicRelease.php b/src/MusicRelease.php index 83df07e0c..5e00d0ea6 100644 --- a/src/MusicRelease.php +++ b/src/MusicRelease.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MusicPlaylistContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A MusicRelease is a specific release of a music album. * * @see http://schema.org/MusicRelease * - * @mixin \Spatie\SchemaOrg\MusicPlaylist */ -class MusicRelease extends BaseType +class MusicRelease extends BaseType implements MusicPlaylistContract, CreativeWorkContract, ThingContract { /** * The catalog number for the release. @@ -84,4 +87,1552 @@ public function releaseOf($releaseOf) return $this->setProperty('releaseOf', $releaseOf); } + /** + * The number of tracks in this album or playlist. + * + * @param int|int[] $numTracks + * + * @return static + * + * @see http://schema.org/numTracks + */ + public function numTracks($numTracks) + { + return $this->setProperty('numTracks', $numTracks); + } + + /** + * A music recording (track)—usually a single song. If an ItemList is + * given, the list should contain items of type MusicRecording. + * + * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track + * + * @return static + * + * @see http://schema.org/track + */ + public function track($track) + { + return $this->setProperty('track', $track); + } + + /** + * A music recording (track)—usually a single song. + * + * @param MusicRecording|MusicRecording[] $tracks + * + * @return static + * + * @see http://schema.org/tracks + */ + public function tracks($tracks) + { + return $this->setProperty('tracks', $tracks); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicReleaseFormatType.php b/src/MusicReleaseFormatType.php index 433380310..f833ee6b6 100644 --- a/src/MusicReleaseFormatType.php +++ b/src/MusicReleaseFormatType.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Format of this release (the type of recording media used, ie. compact disc, * digital media, LP, etc.). * * @see http://schema.org/MusicReleaseFormatType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class MusicReleaseFormatType extends BaseType +class MusicReleaseFormatType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * CDFormat. @@ -61,4 +64,190 @@ class MusicReleaseFormatType extends BaseType */ const VinylFormat = 'http://schema.org/VinylFormat'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicStore.php b/src/MusicStore.php index f9df97a5c..930a0492e 100644 --- a/src/MusicStore.php +++ b/src/MusicStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A music store. * * @see http://schema.org/MusicStore * - * @mixin \Spatie\SchemaOrg\Store */ -class MusicStore extends BaseType +class MusicStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/MusicVenue.php b/src/MusicVenue.php index 4c543e65d..25ee1e864 100644 --- a/src/MusicVenue.php +++ b/src/MusicVenue.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A music venue. * * @see http://schema.org/MusicVenue * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class MusicVenue extends BaseType +class MusicVenue extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/MusicVideoObject.php b/src/MusicVideoObject.php index 454e50be8..f536e609a 100644 --- a/src/MusicVideoObject.php +++ b/src/MusicVideoObject.php @@ -2,13 +2,1772 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A music video file. * * @see http://schema.org/MusicVideoObject * - * @mixin \Spatie\SchemaOrg\MediaObject */ -class MusicVideoObject extends BaseType +class MusicVideoObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Date when this media object was uploaded to this site. + * + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate + * + * @return static + * + * @see http://schema.org/uploadDate + */ + public function uploadDate($uploadDate) + { + return $this->setProperty('uploadDate', $uploadDate); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/NGO.php b/src/NGO.php index dd52f5efc..3cf7b5374 100644 --- a/src/NGO.php +++ b/src/NGO.php @@ -2,13 +2,937 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Organization: Non-governmental Organization. * * @see http://schema.org/NGO * - * @mixin \Spatie\SchemaOrg\Organization */ -class NGO extends BaseType +class NGO extends BaseType implements OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/NailSalon.php b/src/NailSalon.php index 9697d999f..d59c6c477 100644 --- a/src/NailSalon.php +++ b/src/NailSalon.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HealthAndBeautyBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A nail salon. * * @see http://schema.org/NailSalon * - * @mixin \Spatie\SchemaOrg\HealthAndBeautyBusiness */ -class NailSalon extends BaseType +class NailSalon extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/NewsArticle.php b/src/NewsArticle.php index f8508c637..0d0c987c2 100644 --- a/src/NewsArticle.php +++ b/src/NewsArticle.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A NewsArticle is an article whose content reports news, or provides * background context and supporting materials for understanding the news. @@ -11,9 +15,8 @@ * * @see http://schema.org/NewsArticle * - * @mixin \Spatie\SchemaOrg\Article */ -class NewsArticle extends BaseType +class NewsArticle extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { /** * A [dateline](https://en.wikipedia.org/wiki/Dateline) is a brief piece of @@ -102,4 +105,1634 @@ public function printSection($printSection) return $this->setProperty('printSection', $printSection); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/NightClub.php b/src/NightClub.php index 9d10ffb50..93689eb19 100644 --- a/src/NightClub.php +++ b/src/NightClub.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A nightclub or discotheque. * * @see http://schema.org/NightClub * - * @mixin \Spatie\SchemaOrg\EntertainmentBusiness */ -class NightClub extends BaseType +class NightClub extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Notary.php b/src/Notary.php index a51ea5ab7..abd439477 100644 --- a/src/Notary.php +++ b/src/Notary.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LegalServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A notary. * * @see http://schema.org/Notary * - * @mixin \Spatie\SchemaOrg\LegalService */ -class Notary extends BaseType +class Notary extends BaseType implements LegalServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/NoteDigitalDocument.php b/src/NoteDigitalDocument.php index e7b6aa2f5..79eb51237 100644 --- a/src/NoteDigitalDocument.php +++ b/src/NoteDigitalDocument.php @@ -2,13 +2,1537 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A file containing a note, primarily for the author. * * @see http://schema.org/NoteDigitalDocument * - * @mixin \Spatie\SchemaOrg\DigitalDocument */ -class NoteDigitalDocument extends BaseType +class NoteDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract { + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/NutritionInformation.php b/src/NutritionInformation.php index ebe6c84ae..d68d5ea07 100644 --- a/src/NutritionInformation.php +++ b/src/NutritionInformation.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Nutritional information about the recipe. * * @see http://schema.org/NutritionInformation * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class NutritionInformation extends BaseType +class NutritionInformation extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The number of calories. @@ -179,4 +182,190 @@ public function unsaturatedFatContent($unsaturatedFatContent) return $this->setProperty('unsaturatedFatContent', $unsaturatedFatContent); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Occupation.php b/src/Occupation.php index e8c2f7af0..7634a1503 100644 --- a/src/Occupation.php +++ b/src/Occupation.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A profession, may involve prolonged training and/or a formal qualification. * * @see http://schema.org/Occupation * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Occupation extends BaseType +class Occupation extends BaseType implements IntangibleContract, ThingContract { /** * Educational background needed for the position or Occupation. @@ -138,4 +140,190 @@ public function skills($skills) return $this->setProperty('skills', $skills); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OceanBodyOfWater.php b/src/OceanBodyOfWater.php index e3159f557..5a5d79c5a 100644 --- a/src/OceanBodyOfWater.php +++ b/src/OceanBodyOfWater.php @@ -2,13 +2,683 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BodyOfWaterContract; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An ocean (for example, the Pacific). * * @see http://schema.org/OceanBodyOfWater * - * @mixin \Spatie\SchemaOrg\BodyOfWater */ -class OceanBodyOfWater extends BaseType +class OceanBodyOfWater extends BaseType implements BodyOfWaterContract, LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Offer.php b/src/Offer.php index 00502c53d..38039477a 100644 --- a/src/Offer.php +++ b/src/Offer.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An offer to transfer some rights to an item or to provide a service — for * example, an offer to sell tickets to an event, to rent the DVD of a movie, to @@ -17,9 +20,8 @@ * * @see http://schema.org/Offer * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Offer extends BaseType +class Offer extends BaseType implements IntangibleContract, ThingContract { /** * The payment method(s) accepted by seller for this offer. @@ -666,4 +668,190 @@ public function warranty($warranty) return $this->setProperty('warranty', $warranty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OfferCatalog.php b/src/OfferCatalog.php index aac2a8776..8321f7862 100644 --- a/src/OfferCatalog.php +++ b/src/OfferCatalog.php @@ -2,14 +2,258 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ItemListContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An OfferCatalog is an ItemList that contains related Offers and/or further * OfferCatalogs that are offeredBy the same provider. * * @see http://schema.org/OfferCatalog * - * @mixin \Spatie\SchemaOrg\ItemList */ -class OfferCatalog extends BaseType +class OfferCatalog extends BaseType implements ItemListContract, IntangibleContract, ThingContract { + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OfferItemCondition.php b/src/OfferItemCondition.php index 2ca42ccd7..859c1f51d 100644 --- a/src/OfferItemCondition.php +++ b/src/OfferItemCondition.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A list of possible conditions for the item. * * @see http://schema.org/OfferItemCondition * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class OfferItemCondition extends BaseType +class OfferItemCondition extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * Indicates that the item is damaged. @@ -39,4 +42,190 @@ class OfferItemCondition extends BaseType */ const UsedCondition = 'http://schema.org/UsedCondition'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OfficeEquipmentStore.php b/src/OfficeEquipmentStore.php index c0a23b47c..6c30c8ae1 100644 --- a/src/OfficeEquipmentStore.php +++ b/src/OfficeEquipmentStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An office equipment store. * * @see http://schema.org/OfficeEquipmentStore * - * @mixin \Spatie\SchemaOrg\Store */ -class OfficeEquipmentStore extends BaseType +class OfficeEquipmentStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/OnDemandEvent.php b/src/OnDemandEvent.php index 0c96f12ce..0156d941c 100644 --- a/src/OnDemandEvent.php +++ b/src/OnDemandEvent.php @@ -2,14 +2,756 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PublicationEventContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A publication event e.g. catch-up TV or radio podcast, during which a program * is available on-demand. * * @see http://schema.org/OnDemandEvent * - * @mixin \Spatie\SchemaOrg\PublicationEvent */ -class OnDemandEvent extends BaseType +class OnDemandEvent extends BaseType implements PublicationEventContract, EventContract, ThingContract { + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $free + * + * @return static + * + * @see http://schema.org/free + */ + public function free($free) + { + return $this->setProperty('free', $free); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A broadcast service associated with the publication event. + * + * @param BroadcastService|BroadcastService[] $publishedOn + * + * @return static + * + * @see http://schema.org/publishedOn + */ + public function publishedOn($publishedOn) + { + return $this->setProperty('publishedOn', $publishedOn); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OpeningHoursSpecification.php b/src/OpeningHoursSpecification.php index b83b5b829..668a68455 100644 --- a/src/OpeningHoursSpecification.php +++ b/src/OpeningHoursSpecification.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A structured value providing information about the opening hours of a place * or a certain service inside a place. @@ -15,9 +19,8 @@ * * @see http://schema.org/OpeningHoursSpecification * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class OpeningHoursSpecification extends BaseType +class OpeningHoursSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The closing hour of the place or service on the given day(s) of the week. @@ -90,4 +93,190 @@ public function validThrough($validThrough) return $this->setProperty('validThrough', $validThrough); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Order.php b/src/Order.php index 7b0ecffbf..b76b658af 100644 --- a/src/Order.php +++ b/src/Order.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An order is a confirmation of a transaction (a receipt), which can contain * multiple line items, each represented by an Offer that has been accepted by @@ -9,9 +12,8 @@ * * @see http://schema.org/Order * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Order extends BaseType +class Order extends BaseType implements IntangibleContract, ThingContract { /** * The offer(s) -- e.g., product, quantity and price combinations -- @@ -335,4 +337,190 @@ public function seller($seller) return $this->setProperty('seller', $seller); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OrderAction.php b/src/OrderAction.php index 2c454ecef..faefb6536 100644 --- a/src/OrderAction.php +++ b/src/OrderAction.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent orders an object/product/service to be delivered/sent. * * @see http://schema.org/OrderAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class OrderAction extends BaseType +class OrderAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** * A sub property of instrument. The method of delivery. @@ -25,4 +28,444 @@ public function deliveryMethod($deliveryMethod) return $this->setProperty('deliveryMethod', $deliveryMethod); } + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OrderItem.php b/src/OrderItem.php index c3509a788..8c4a86285 100644 --- a/src/OrderItem.php +++ b/src/OrderItem.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An order item is a line of an order. It includes the quantity and shipping * details of a bought offer. * * @see http://schema.org/OrderItem * - * @mixin \Spatie\SchemaOrg\Intangible */ -class OrderItem extends BaseType +class OrderItem extends BaseType implements IntangibleContract, ThingContract { /** * The delivery of the parcel related to this order or order item. @@ -83,4 +85,190 @@ public function orderedItem($orderedItem) return $this->setProperty('orderedItem', $orderedItem); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OrderStatus.php b/src/OrderStatus.php index 4dd7b3ec3..5121b49ac 100644 --- a/src/OrderStatus.php +++ b/src/OrderStatus.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Enumerated status values for Order. * * @see http://schema.org/OrderStatus * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class OrderStatus extends BaseType +class OrderStatus extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * OrderStatus representing cancellation of an order. @@ -67,4 +70,190 @@ class OrderStatus extends BaseType */ const OrderReturned = 'http://schema.org/OrderReturned'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Organization.php b/src/Organization.php index 2ce6692ac..072465088 100644 --- a/src/Organization.php +++ b/src/Organization.php @@ -2,14 +2,15 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An organization such as a school, NGO, corporation, club, etc. * * @see http://schema.org/Organization * - * @mixin \Spatie\SchemaOrg\Thing */ -class Organization extends BaseType +class Organization extends BaseType implements ThingContract { /** * The schema.org Actions mechanism benefited from extensive discussions @@ -916,4 +917,190 @@ public function vatID($vatID) return $this->setProperty('vatID', $vatID); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OrganizationRole.php b/src/OrganizationRole.php index 1d1f92816..8bfa04518 100644 --- a/src/OrganizationRole.php +++ b/src/OrganizationRole.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\RoleContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A subclass of Role used to describe roles within organizations. * * @see http://schema.org/OrganizationRole * - * @mixin \Spatie\SchemaOrg\Role */ -class OrganizationRole extends BaseType +class OrganizationRole extends BaseType implements RoleContract, IntangibleContract, ThingContract { /** * A number associated with a role in an organization, for example, the @@ -26,4 +29,253 @@ public function numberedPosition($numberedPosition) return $this->setProperty('numberedPosition', $numberedPosition); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * A position played, performed or filled by a person or organization, as + * part of an organization. For example, an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $namedPosition + * + * @return static + * + * @see http://schema.org/namedPosition + */ + public function namedPosition($namedPosition) + { + return $this->setProperty('namedPosition', $namedPosition); + } + + /** + * A role played, performed or filled by a person or organization. For + * example, the team of creators for a comic book might fill the roles named + * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $roleName + * + * @return static + * + * @see http://schema.org/roleName + */ + public function roleName($roleName) + { + return $this->setProperty('roleName', $roleName); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OrganizeAction.php b/src/OrganizeAction.php index 8eea90d19..26463ee11 100644 --- a/src/OrganizeAction.php +++ b/src/OrganizeAction.php @@ -2,14 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of manipulating/administering/supervising/controlling one or more * objects. * * @see http://schema.org/OrganizeAction * - * @mixin \Spatie\SchemaOrg\Action */ -class OrganizeAction extends BaseType +class OrganizeAction extends BaseType implements ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/OutletStore.php b/src/OutletStore.php index 254ca9223..7a6f5e857 100644 --- a/src/OutletStore.php +++ b/src/OutletStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An outlet store. * * @see http://schema.org/OutletStore * - * @mixin \Spatie\SchemaOrg\Store */ -class OutletStore extends BaseType +class OutletStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/OwnershipInfo.php b/src/OwnershipInfo.php index 051c94458..29adff67c 100644 --- a/src/OwnershipInfo.php +++ b/src/OwnershipInfo.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A structured value providing information about when a certain organization or * person owned a certain product. * * @see http://schema.org/OwnershipInfo * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class OwnershipInfo extends BaseType +class OwnershipInfo extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The organization or person from which the product was acquired. @@ -68,4 +71,190 @@ public function typeOfGood($typeOfGood) return $this->setProperty('typeOfGood', $typeOfGood); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PaintAction.php b/src/PaintAction.php index 562477a25..271863788 100644 --- a/src/PaintAction.php +++ b/src/PaintAction.php @@ -2,14 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of producing a painting, typically with paint and canvas as * instruments. * * @see http://schema.org/PaintAction * - * @mixin \Spatie\SchemaOrg\CreateAction */ -class PaintAction extends BaseType +class PaintAction extends BaseType implements CreateActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Painting.php b/src/Painting.php index 54a4268e5..ca8867de0 100644 --- a/src/Painting.php +++ b/src/Painting.php @@ -2,13 +2,1520 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A painting. * * @see http://schema.org/Painting * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Painting extends BaseType +class Painting extends BaseType implements CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ParcelDelivery.php b/src/ParcelDelivery.php index ddb33dde7..eea168a13 100644 --- a/src/ParcelDelivery.php +++ b/src/ParcelDelivery.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The delivery of a parcel either via the postal service or a commercial * service. * * @see http://schema.org/ParcelDelivery * - * @mixin \Spatie\SchemaOrg\Intangible */ -class ParcelDelivery extends BaseType +class ParcelDelivery extends BaseType implements IntangibleContract, ThingContract { /** * 'carrier' is an out-dated term indicating the 'provider' for parcel @@ -184,4 +186,190 @@ public function trackingUrl($trackingUrl) return $this->setProperty('trackingUrl', $trackingUrl); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ParcelService.php b/src/ParcelService.php index 90d815fe7..1d8ec24bc 100644 --- a/src/ParcelService.php +++ b/src/ParcelService.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\DeliveryMethodContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A private parcel service as the delivery mode available for a certain offer. * @@ -13,8 +18,193 @@ * * @see http://schema.org/ParcelService * - * @mixin \Spatie\SchemaOrg\DeliveryMethod */ -class ParcelService extends BaseType +class ParcelService extends BaseType implements DeliveryMethodContract, EnumerationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ParentAudience.php b/src/ParentAudience.php index 2c558e31f..79f6d20bc 100644 --- a/src/ParentAudience.php +++ b/src/ParentAudience.php @@ -2,15 +2,19 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PeopleAudienceContract; +use \Spatie\SchemaOrg\Contracts\AudienceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A set of characteristics describing parents, who can be interested in viewing * some content. * * @see http://schema.org/ParentAudience * - * @mixin \Spatie\SchemaOrg\PeopleAudience */ -class ParentAudience extends BaseType +class ParentAudience extends BaseType implements PeopleAudienceContract, AudienceContract, IntangibleContract, ThingContract { /** * Maximal age of the child. @@ -40,4 +44,303 @@ public function childMinAge($childMinAge) return $this->setProperty('childMinAge', $childMinAge); } + /** + * Audiences defined by a person's gender. + * + * @param string|string[] $requiredGender + * + * @return static + * + * @see http://schema.org/requiredGender + */ + public function requiredGender($requiredGender) + { + return $this->setProperty('requiredGender', $requiredGender); + } + + /** + * Audiences defined by a person's maximum age. + * + * @param int|int[] $requiredMaxAge + * + * @return static + * + * @see http://schema.org/requiredMaxAge + */ + public function requiredMaxAge($requiredMaxAge) + { + return $this->setProperty('requiredMaxAge', $requiredMaxAge); + } + + /** + * Audiences defined by a person's minimum age. + * + * @param int|int[] $requiredMinAge + * + * @return static + * + * @see http://schema.org/requiredMinAge + */ + public function requiredMinAge($requiredMinAge) + { + return $this->setProperty('requiredMinAge', $requiredMinAge); + } + + /** + * The gender of the person or audience. + * + * @param string|string[] $suggestedGender + * + * @return static + * + * @see http://schema.org/suggestedGender + */ + public function suggestedGender($suggestedGender) + { + return $this->setProperty('suggestedGender', $suggestedGender); + } + + /** + * Maximal age recommended for viewing content. + * + * @param float|float[]|int|int[] $suggestedMaxAge + * + * @return static + * + * @see http://schema.org/suggestedMaxAge + */ + public function suggestedMaxAge($suggestedMaxAge) + { + return $this->setProperty('suggestedMaxAge', $suggestedMaxAge); + } + + /** + * Minimal age recommended for viewing content. + * + * @param float|float[]|int|int[] $suggestedMinAge + * + * @return static + * + * @see http://schema.org/suggestedMinAge + */ + public function suggestedMinAge($suggestedMinAge) + { + return $this->setProperty('suggestedMinAge', $suggestedMinAge); + } + + /** + * The target group associated with a given audience (e.g. veterans, car + * owners, musicians, etc.). + * + * @param string|string[] $audienceType + * + * @return static + * + * @see http://schema.org/audienceType + */ + public function audienceType($audienceType) + { + return $this->setProperty('audienceType', $audienceType); + } + + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Park.php b/src/Park.php index 35d0a7339..3cfd81566 100644 --- a/src/Park.php +++ b/src/Park.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A park. * * @see http://schema.org/Park * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Park extends BaseType +class Park extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ParkingFacility.php b/src/ParkingFacility.php index 3b3a8df39..260808452 100644 --- a/src/ParkingFacility.php +++ b/src/ParkingFacility.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A parking lot or other parking facility. * * @see http://schema.org/ParkingFacility * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class ParkingFacility extends BaseType +class ParkingFacility extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PawnShop.php b/src/PawnShop.php index 2e661e3f3..ea58a961e 100644 --- a/src/PawnShop.php +++ b/src/PawnShop.php @@ -2,14 +2,1340 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A shop that will buy, or lend money against the security of, personal * possessions. * * @see http://schema.org/PawnShop * - * @mixin \Spatie\SchemaOrg\Store */ -class PawnShop extends BaseType +class PawnShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/PayAction.php b/src/PayAction.php index c9f426ddd..9b0582bf0 100644 --- a/src/PayAction.php +++ b/src/PayAction.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent pays a price to a participant. * * @see http://schema.org/PayAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class PayAction extends BaseType +class PayAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** * A sub property of participant. The participant who is at the receiving @@ -26,4 +29,444 @@ public function recipient($recipient) return $this->setProperty('recipient', $recipient); } + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PaymentCard.php b/src/PaymentCard.php index 9d8e71ee6..5dc4e4f4e 100644 --- a/src/PaymentCard.php +++ b/src/PaymentCard.php @@ -2,15 +2,590 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\PaymentMethodContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A payment method using a credit, debit, store or other card to associate the * payment with an account. * * @see http://schema.org/PaymentCard * - * @mixin \Spatie\SchemaOrg\FinancialProduct - * @mixin \Spatie\SchemaOrg\PaymentMethod */ -class PaymentCard extends BaseType +class PaymentCard extends BaseType implements FinancialProductContract, PaymentMethodContract, EnumerationContract, IntangibleContract, ThingContract { + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * + * @return static + * + * @see http://schema.org/interestRate + */ + public function interestRate($interestRate) + { + return $this->setProperty('interestRate', $interestRate); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PaymentChargeSpecification.php b/src/PaymentChargeSpecification.php index 48de4582d..9482f3887 100644 --- a/src/PaymentChargeSpecification.php +++ b/src/PaymentChargeSpecification.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PriceSpecificationContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The costs of settling the payment using a particular payment method. * * @see http://schema.org/PaymentChargeSpecification * - * @mixin \Spatie\SchemaOrg\PriceSpecification */ -class PaymentChargeSpecification extends BaseType +class PaymentChargeSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract { /** * The delivery method(s) to which the delivery charge or payment charge @@ -40,4 +44,355 @@ public function appliesToPaymentMethod($appliesToPaymentMethod) return $this->setProperty('appliesToPaymentMethod', $appliesToPaymentMethod); } + /** + * The interval and unit of measurement of ordering quantities for which the + * offer or price specification is valid. This allows e.g. specifying that a + * certain freight charge is valid only for a certain quantity. + * + * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity + * + * @return static + * + * @see http://schema.org/eligibleQuantity + */ + public function eligibleQuantity($eligibleQuantity) + { + return $this->setProperty('eligibleQuantity', $eligibleQuantity); + } + + /** + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. + * + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * + * @return static + * + * @see http://schema.org/eligibleTransactionVolume + */ + public function eligibleTransactionVolume($eligibleTransactionVolume) + { + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + } + + /** + * The highest price if the price is a range. + * + * @param float|float[]|int|int[] $maxPrice + * + * @return static + * + * @see http://schema.org/maxPrice + */ + public function maxPrice($maxPrice) + { + return $this->setProperty('maxPrice', $maxPrice); + } + + /** + * The lowest price if the price is a range. + * + * @param float|float[]|int|int[] $minPrice + * + * @return static + * + * @see http://schema.org/minPrice + */ + public function minPrice($minPrice) + { + return $this->setProperty('minPrice', $minPrice); + } + + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * + * @return static + * + * @see http://schema.org/validThrough + */ + public function validThrough($validThrough) + { + return $this->setProperty('validThrough', $validThrough); + } + + /** + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. + * + * @param bool|bool[] $valueAddedTaxIncluded + * + * @return static + * + * @see http://schema.org/valueAddedTaxIncluded + */ + public function valueAddedTaxIncluded($valueAddedTaxIncluded) + { + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PaymentMethod.php b/src/PaymentMethod.php index da4ae8f64..8a37e2104 100644 --- a/src/PaymentMethod.php +++ b/src/PaymentMethod.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A payment method is a standardized procedure for transferring the monetary * amount for a purchase. Payment methods are characterized by the legal and @@ -22,8 +26,193 @@ * * @see http://schema.org/PaymentMethod * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class PaymentMethod extends BaseType +class PaymentMethod extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PaymentService.php b/src/PaymentService.php index 1633d1f15..323f5b657 100644 --- a/src/PaymentService.php +++ b/src/PaymentService.php @@ -2,14 +2,589 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Service to transfer funds from a person or organization to a beneficiary * person or organization. * * @see http://schema.org/PaymentService * - * @mixin \Spatie\SchemaOrg\FinancialProduct */ -class PaymentService extends BaseType +class PaymentService extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + + /** + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * + * @return static + * + * @see http://schema.org/interestRate + */ + public function interestRate($interestRate) + { + return $this->setProperty('interestRate', $interestRate); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PaymentStatusType.php b/src/PaymentStatusType.php index e20f8cb3d..0ca8537d4 100644 --- a/src/PaymentStatusType.php +++ b/src/PaymentStatusType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A specific payment status. For example, PaymentDue, PaymentComplete, etc. * * @see http://schema.org/PaymentStatusType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class PaymentStatusType extends BaseType +class PaymentStatusType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * An automatic payment system is in place and will be used. @@ -46,4 +49,190 @@ class PaymentStatusType extends BaseType */ const PaymentPastDue = 'http://schema.org/PaymentPastDue'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PeopleAudience.php b/src/PeopleAudience.php index 72fd2f79c..82ac88082 100644 --- a/src/PeopleAudience.php +++ b/src/PeopleAudience.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AudienceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A set of characteristics belonging to people, e.g. who compose an item's * target audience. * * @see http://schema.org/PeopleAudience * - * @mixin \Spatie\SchemaOrg\Audience */ -class PeopleAudience extends BaseType +class PeopleAudience extends BaseType implements AudienceContract, IntangibleContract, ThingContract { /** * Audiences defined by a person's gender. @@ -96,4 +99,219 @@ public function suggestedMinAge($suggestedMinAge) return $this->setProperty('suggestedMinAge', $suggestedMinAge); } + /** + * The target group associated with a given audience (e.g. veterans, car + * owners, musicians, etc.). + * + * @param string|string[] $audienceType + * + * @return static + * + * @see http://schema.org/audienceType + */ + public function audienceType($audienceType) + { + return $this->setProperty('audienceType', $audienceType); + } + + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PerformAction.php b/src/PerformAction.php index d93269d9c..f232979c0 100644 --- a/src/PerformAction.php +++ b/src/PerformAction.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlayActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of participating in performance arts. * * @see http://schema.org/PerformAction * - * @mixin \Spatie\SchemaOrg\PlayAction */ -class PerformAction extends BaseType +class PerformAction extends BaseType implements PlayActionContract, ActionContract, ThingContract { /** * A sub property of location. The entertainment business where the action @@ -26,4 +29,398 @@ public function entertainmentBusiness($entertainmentBusiness) return $this->setProperty('entertainmentBusiness', $entertainmentBusiness); } + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PerformanceRole.php b/src/PerformanceRole.php index bd4375234..7102fd6aa 100644 --- a/src/PerformanceRole.php +++ b/src/PerformanceRole.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\RoleContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A PerformanceRole is a Role that some entity places with regard to a * theatrical performance, e.g. in a Movie, TVSeries etc. * * @see http://schema.org/PerformanceRole * - * @mixin \Spatie\SchemaOrg\Role */ -class PerformanceRole extends BaseType +class PerformanceRole extends BaseType implements RoleContract, IntangibleContract, ThingContract { /** * The name of a character played in some acting or performing role, i.e. in @@ -27,4 +30,253 @@ public function characterName($characterName) return $this->setProperty('characterName', $characterName); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * A position played, performed or filled by a person or organization, as + * part of an organization. For example, an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $namedPosition + * + * @return static + * + * @see http://schema.org/namedPosition + */ + public function namedPosition($namedPosition) + { + return $this->setProperty('namedPosition', $namedPosition); + } + + /** + * A role played, performed or filled by a person or organization. For + * example, the team of creators for a comic book might fill the roles named + * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $roleName + * + * @return static + * + * @see http://schema.org/roleName + */ + public function roleName($roleName) + { + return $this->setProperty('roleName', $roleName); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PerformingArtsTheater.php b/src/PerformingArtsTheater.php index 13ce62415..5f9edc21e 100644 --- a/src/PerformingArtsTheater.php +++ b/src/PerformingArtsTheater.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A theater or other performing art center. * * @see http://schema.org/PerformingArtsTheater * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class PerformingArtsTheater extends BaseType +class PerformingArtsTheater extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PerformingGroup.php b/src/PerformingGroup.php index 6aaf45352..2feb139dd 100644 --- a/src/PerformingGroup.php +++ b/src/PerformingGroup.php @@ -2,13 +2,937 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A performance group, such as a band, an orchestra, or a circus. * * @see http://schema.org/PerformingGroup * - * @mixin \Spatie\SchemaOrg\Organization */ -class PerformingGroup extends BaseType +class PerformingGroup extends BaseType implements OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Periodical.php b/src/Periodical.php index 80f457709..65c28e602 100644 --- a/src/Periodical.php +++ b/src/Periodical.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A publication in any medium issued in successive parts bearing numerical or * chronological designations and intended, such as a magazine, scholarly @@ -12,8 +18,1574 @@ * * @see http://schema.org/Periodical * - * @mixin \Spatie\SchemaOrg\CreativeWorkSeries */ -class Periodical extends BaseType +class Periodical extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + } diff --git a/src/Permit.php b/src/Permit.php index 5f9a25d9c..50ba4c1ba 100644 --- a/src/Permit.php +++ b/src/Permit.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A permit issued by an organization, e.g. a parking pass. * * @see http://schema.org/Permit * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Permit extends BaseType +class Permit extends BaseType implements IntangibleContract, ThingContract { /** * The organization issuing the ticket or permit. @@ -109,4 +111,190 @@ public function validUntil($validUntil) return $this->setProperty('validUntil', $validUntil); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Person.php b/src/Person.php index 6f8e1e5eb..7b7231772 100644 --- a/src/Person.php +++ b/src/Person.php @@ -2,14 +2,15 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A person (alive, dead, undead, or fictional). * * @see http://schema.org/Person * - * @mixin \Spatie\SchemaOrg\Thing */ -class Person extends BaseType +class Person extends BaseType implements ThingContract { /** * An additional name for a Person, can be used for a middle name. @@ -841,4 +842,190 @@ public function worksFor($worksFor) return $this->setProperty('worksFor', $worksFor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PetStore.php b/src/PetStore.php index 9169eb808..900f96376 100644 --- a/src/PetStore.php +++ b/src/PetStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A pet store. * * @see http://schema.org/PetStore * - * @mixin \Spatie\SchemaOrg\Store */ -class PetStore extends BaseType +class PetStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Pharmacy.php b/src/Pharmacy.php index 43107e5dc..957965205 100644 --- a/src/Pharmacy.php +++ b/src/Pharmacy.php @@ -2,13 +2,938 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A pharmacy or drugstore. * * @see http://schema.org/Pharmacy * - * @mixin \Spatie\SchemaOrg\MedicalOrganization */ -class Pharmacy extends BaseType +class Pharmacy extends BaseType implements MedicalOrganizationContract, OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Photograph.php b/src/Photograph.php index e3a3954e5..99e6f0828 100644 --- a/src/Photograph.php +++ b/src/Photograph.php @@ -2,13 +2,1520 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A photograph. * * @see http://schema.org/Photograph * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Photograph extends BaseType +class Photograph extends BaseType implements CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PhotographAction.php b/src/PhotographAction.php index 1d3debac5..c0fcc102e 100644 --- a/src/PhotographAction.php +++ b/src/PhotographAction.php @@ -2,13 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of capturing still images of objects using a camera. * * @see http://schema.org/PhotographAction * - * @mixin \Spatie\SchemaOrg\CreateAction */ -class PhotographAction extends BaseType +class PhotographAction extends BaseType implements CreateActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Physician.php b/src/Physician.php index daec09b0e..06c53e54f 100644 --- a/src/Physician.php +++ b/src/Physician.php @@ -2,13 +2,938 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A doctor's office. * * @see http://schema.org/Physician * - * @mixin \Spatie\SchemaOrg\MedicalOrganization */ -class Physician extends BaseType +class Physician extends BaseType implements MedicalOrganizationContract, OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Place.php b/src/Place.php index eb9875648..1ca29e7f9 100644 --- a/src/Place.php +++ b/src/Place.php @@ -2,14 +2,15 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Entities that have a somewhat fixed, physical extension. * * @see http://schema.org/Place * - * @mixin \Spatie\SchemaOrg\Thing */ -class Place extends BaseType +class Place extends BaseType implements ThingContract { /** * A property-value pair representing an additional characteristics of the @@ -260,6 +261,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * An associated logo. * @@ -274,6 +290,21 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + /** * A URL to a map of the place. * @@ -461,4 +492,190 @@ public function telephone($telephone) return $this->setProperty('telephone', $telephone); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PlaceOfWorship.php b/src/PlaceOfWorship.php index 856383167..c4da23497 100644 --- a/src/PlaceOfWorship.php +++ b/src/PlaceOfWorship.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Place of worship, such as a church, synagogue, or mosque. * * @see http://schema.org/PlaceOfWorship * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class PlaceOfWorship extends BaseType +class PlaceOfWorship extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PlanAction.php b/src/PlanAction.php index 280121dd5..c48f1553f 100644 --- a/src/PlanAction.php +++ b/src/PlanAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of planning the execution of an event/task/action/reservation/plan to * a future date. * * @see http://schema.org/PlanAction * - * @mixin \Spatie\SchemaOrg\OrganizeAction */ -class PlanAction extends BaseType +class PlanAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract { /** * The time the object is scheduled to. @@ -26,4 +29,369 @@ public function scheduledTime($scheduledTime) return $this->setProperty('scheduledTime', $scheduledTime); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PlayAction.php b/src/PlayAction.php index f07efa91d..987d3c628 100644 --- a/src/PlayAction.php +++ b/src/PlayAction.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of playing/exercising/training/performing for enjoyment, leisure, * recreation, Competition or exercise. @@ -17,9 +20,8 @@ * * @see http://schema.org/PlayAction * - * @mixin \Spatie\SchemaOrg\Action */ -class PlayAction extends BaseType +class PlayAction extends BaseType implements ActionContract, ThingContract { /** * An intended audience, i.e. a group for whom something was created. @@ -50,4 +52,369 @@ public function event($event) return $this->setProperty('event', $event); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Playground.php b/src/Playground.php index 96633572d..1c76d9684 100644 --- a/src/Playground.php +++ b/src/Playground.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A playground. * * @see http://schema.org/Playground * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Playground extends BaseType +class Playground extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Plumber.php b/src/Plumber.php index 22f0d9ad5..7eaf3aa81 100644 --- a/src/Plumber.php +++ b/src/Plumber.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HomeAndConstructionBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A plumbing service. * * @see http://schema.org/Plumber * - * @mixin \Spatie\SchemaOrg\HomeAndConstructionBusiness */ -class Plumber extends BaseType +class Plumber extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/PoliceStation.php b/src/PoliceStation.php index 22e73762b..147d1938c 100644 --- a/src/PoliceStation.php +++ b/src/PoliceStation.php @@ -2,14 +2,1340 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A police station. * * @see http://schema.org/PoliceStation * - * @mixin \Spatie\SchemaOrg\CivicStructure - * @mixin \Spatie\SchemaOrg\EmergencyService */ -class PoliceStation extends BaseType +class PoliceStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + } diff --git a/src/Pond.php b/src/Pond.php index 086819b9b..6d952a913 100644 --- a/src/Pond.php +++ b/src/Pond.php @@ -2,13 +2,683 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BodyOfWaterContract; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A pond. * * @see http://schema.org/Pond * - * @mixin \Spatie\SchemaOrg\BodyOfWater */ -class Pond extends BaseType +class Pond extends BaseType implements BodyOfWaterContract, LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PostOffice.php b/src/PostOffice.php index ebea27033..7c11c29a2 100644 --- a/src/PostOffice.php +++ b/src/PostOffice.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\GovernmentOfficeContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A post office. * * @see http://schema.org/PostOffice * - * @mixin \Spatie\SchemaOrg\GovernmentOffice */ -class PostOffice extends BaseType +class PostOffice extends BaseType implements GovernmentOfficeContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/PostalAddress.php b/src/PostalAddress.php index e1f27ba44..1434a53ed 100644 --- a/src/PostalAddress.php +++ b/src/PostalAddress.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ContactPointContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The mailing address. * * @see http://schema.org/PostalAddress * - * @mixin \Spatie\SchemaOrg\ContactPoint */ -class PostalAddress extends BaseType +class PostalAddress extends BaseType implements ContactPointContract, StructuredValueContract, IntangibleContract, ThingContract { /** * The country. For example, USA. You can also provide the two-letter [ISO @@ -99,4 +103,338 @@ public function streetAddress($streetAddress) return $this->setProperty('streetAddress', $streetAddress); } + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * + * @param Language|Language[]|string|string[] $availableLanguage + * + * @return static + * + * @see http://schema.org/availableLanguage + */ + public function availableLanguage($availableLanguage) + { + return $this->setProperty('availableLanguage', $availableLanguage); + } + + /** + * An option available on this contact point (e.g. a toll-free number or + * support for hearing-impaired callers). + * + * @param ContactPointOption|ContactPointOption[] $contactOption + * + * @return static + * + * @see http://schema.org/contactOption + */ + public function contactOption($contactOption) + { + return $this->setProperty('contactOption', $contactOption); + } + + /** + * A person or organization can have different contact points, for different + * purposes. For example, a sales contact point, a PR contact point and so + * on. This property is used to specify the kind of contact point. + * + * @param string|string[] $contactType + * + * @return static + * + * @see http://schema.org/contactType + */ + public function contactType($contactType) + { + return $this->setProperty('contactType', $contactType); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * The product or service this support contact point is related to (such as + * product support for a particular product line). This can be a specific + * product or product line (e.g. "iPhone") or a general category of products + * or services (e.g. "smartphones"). + * + * @param Product|Product[]|string|string[] $productSupported + * + * @return static + * + * @see http://schema.org/productSupported + */ + public function productSupported($productSupported) + { + return $this->setProperty('productSupported', $productSupported); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PreOrderAction.php b/src/PreOrderAction.php index 94345ea3d..309204447 100644 --- a/src/PreOrderAction.php +++ b/src/PreOrderAction.php @@ -2,14 +2,457 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent orders a (not yet released) object/product/service to be * delivered/sent. * * @see http://schema.org/PreOrderAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class PreOrderAction extends BaseType +class PreOrderAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PrependAction.php b/src/PrependAction.php index 7e40cbd37..060d13cde 100644 --- a/src/PrependAction.php +++ b/src/PrependAction.php @@ -2,13 +2,426 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InsertActionContract; +use \Spatie\SchemaOrg\Contracts\AddActionContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of inserting at the beginning if an ordered collection. * * @see http://schema.org/PrependAction * - * @mixin \Spatie\SchemaOrg\InsertAction */ -class PrependAction extends BaseType +class PrependAction extends BaseType implements InsertActionContract, AddActionContract, UpdateActionContract, ActionContract, ThingContract { + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $collection + * + * @return static + * + * @see http://schema.org/collection + */ + public function collection($collection) + { + return $this->setProperty('collection', $collection); + } + + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $targetCollection + * + * @return static + * + * @see http://schema.org/targetCollection + */ + public function targetCollection($targetCollection) + { + return $this->setProperty('targetCollection', $targetCollection); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Preschool.php b/src/Preschool.php index 03c873f02..c6915fc76 100644 --- a/src/Preschool.php +++ b/src/Preschool.php @@ -2,13 +2,952 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EducationalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A preschool. * * @see http://schema.org/Preschool * - * @mixin \Spatie\SchemaOrg\EducationalOrganization */ -class Preschool extends BaseType +class Preschool extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PresentationDigitalDocument.php b/src/PresentationDigitalDocument.php index 298f25070..af26816c8 100644 --- a/src/PresentationDigitalDocument.php +++ b/src/PresentationDigitalDocument.php @@ -2,13 +2,1537 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A file containing slides or used for a presentation. * * @see http://schema.org/PresentationDigitalDocument * - * @mixin \Spatie\SchemaOrg\DigitalDocument */ -class PresentationDigitalDocument extends BaseType +class PresentationDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract { + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PriceSpecification.php b/src/PriceSpecification.php index a9a788397..b4af1b732 100644 --- a/src/PriceSpecification.php +++ b/src/PriceSpecification.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A structured value representing a price or price range. Typically, only the * subclasses of this type are used for markup. It is recommended to use @@ -10,9 +14,8 @@ * * @see http://schema.org/PriceSpecification * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class PriceSpecification extends BaseType +class PriceSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The interval and unit of measurement of ordering quantities for which the @@ -179,4 +182,190 @@ public function valueAddedTaxIncluded($valueAddedTaxIncluded) return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Product.php b/src/Product.php index 643f4711d..9f7a46e88 100644 --- a/src/Product.php +++ b/src/Product.php @@ -2,6 +2,8 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Any offered product or service. For example: a pair of shoes; a concert * ticket; the rental of a car; a haircut; or an episode of a TV show streamed @@ -9,9 +11,8 @@ * * @see http://schema.org/Product * - * @mixin \Spatie\SchemaOrg\Thing */ -class Product extends BaseType +class Product extends BaseType implements ThingContract { /** * A property-value pair representing an additional characteristics of the @@ -547,4 +548,190 @@ public function width($width) return $this->setProperty('width', $width); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ProductModel.php b/src/ProductModel.php index 3c016633f..e208816f9 100644 --- a/src/ProductModel.php +++ b/src/ProductModel.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ProductContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A datasheet or vendor specification of a product (in the sense of a * prototypical description). * * @see http://schema.org/ProductModel * - * @mixin \Spatie\SchemaOrg\Product */ -class ProductModel extends BaseType +class ProductModel extends BaseType implements ProductContract, ThingContract { /** * A pointer to a base product from which this product is a variant. It is @@ -58,4 +60,724 @@ public function successorOf($successorOf) return $this->setProperty('successorOf', $successorOf); } + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * The color of the product. + * + * @param string|string[] $color + * + * @return static + * + * @see http://schema.org/color + */ + public function color($color) + { + return $this->setProperty('color', $color); + } + + /** + * The depth of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth + * + * @return static + * + * @see http://schema.org/depth + */ + public function depth($depth) + { + return $this->setProperty('depth', $depth); + } + + /** + * The GTIN-12 code of the product, or the product to which the offer + * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a + * U.P.C. Company Prefix, Item Reference, and Check Digit used to identify + * trade items. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin12 + * + * @return static + * + * @see http://schema.org/gtin12 + */ + public function gtin12($gtin12) + { + return $this->setProperty('gtin12', $gtin12); + } + + /** + * The GTIN-13 code of the product, or the product to which the offer + * refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former + * 12-digit UPC codes can be converted into a GTIN-13 code by simply adding + * a preceeding zero. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin13 + * + * @return static + * + * @see http://schema.org/gtin13 + */ + public function gtin13($gtin13) + { + return $this->setProperty('gtin13', $gtin13); + } + + /** + * The GTIN-14 code of the product, or the product to which the offer + * refers. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin14 + * + * @return static + * + * @see http://schema.org/gtin14 + */ + public function gtin14($gtin14) + { + return $this->setProperty('gtin14', $gtin14); + } + + /** + * The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of + * the product, or the product to which the offer refers. This code is also + * known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin8 + * + * @return static + * + * @see http://schema.org/gtin8 + */ + public function gtin8($gtin8) + { + return $this->setProperty('gtin8', $gtin8); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is an accessory or spare part. + * + * @param Product|Product[] $isAccessoryOrSparePartFor + * + * @return static + * + * @see http://schema.org/isAccessoryOrSparePartFor + */ + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor) + { + return $this->setProperty('isAccessoryOrSparePartFor', $isAccessoryOrSparePartFor); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is a consumable. + * + * @param Product|Product[] $isConsumableFor + * + * @return static + * + * @see http://schema.org/isConsumableFor + */ + public function isConsumableFor($isConsumableFor) + { + return $this->setProperty('isConsumableFor', $isConsumableFor); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * A predefined value from OfferItemCondition or a textual description of + * the condition of the product or service, or the products or services + * included in the offer. + * + * @param OfferItemCondition|OfferItemCondition[] $itemCondition + * + * @return static + * + * @see http://schema.org/itemCondition + */ + public function itemCondition($itemCondition) + { + return $this->setProperty('itemCondition', $itemCondition); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The manufacturer of the product. + * + * @param Organization|Organization[] $manufacturer + * + * @return static + * + * @see http://schema.org/manufacturer + */ + public function manufacturer($manufacturer) + { + return $this->setProperty('manufacturer', $manufacturer); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * The model of the product. Use with the URL of a ProductModel or a textual + * representation of the model identifier. The URL of the ProductModel can + * be from an external source. It is recommended to additionally provide + * strong product identifiers via the gtin8/gtin13/gtin14 and mpn + * properties. + * + * @param ProductModel|ProductModel[]|string|string[] $model + * + * @return static + * + * @see http://schema.org/model + */ + public function model($model) + { + return $this->setProperty('model', $model); + } + + /** + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. + * + * @param string|string[] $mpn + * + * @return static + * + * @see http://schema.org/mpn + */ + public function mpn($mpn) + { + return $this->setProperty('mpn', $mpn); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The product identifier, such as ISBN. For example: ``` meta + * itemprop="productID" content="isbn:123-456-789" ```. + * + * @param string|string[] $productID + * + * @return static + * + * @see http://schema.org/productID + */ + public function productID($productID) + { + return $this->setProperty('productID', $productID); + } + + /** + * The date of production of the item, e.g. vehicle. + * + * @param \DateTimeInterface|\DateTimeInterface[] $productionDate + * + * @return static + * + * @see http://schema.org/productionDate + */ + public function productionDate($productionDate) + { + return $this->setProperty('productionDate', $productionDate); + } + + /** + * The date the item e.g. vehicle was purchased by the current owner. + * + * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate + * + * @return static + * + * @see http://schema.org/purchaseDate + */ + public function purchaseDate($purchaseDate) + { + return $this->setProperty('purchaseDate', $purchaseDate); + } + + /** + * The release date of a product or product model. This can be used to + * distinguish the exact variant of a product. + * + * @param \DateTimeInterface|\DateTimeInterface[] $releaseDate + * + * @return static + * + * @see http://schema.org/releaseDate + */ + public function releaseDate($releaseDate) + { + return $this->setProperty('releaseDate', $releaseDate); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a + * product or service, or the product to which the offer refers. + * + * @param string|string[] $sku + * + * @return static + * + * @see http://schema.org/sku + */ + public function sku($sku) + { + return $this->setProperty('sku', $sku); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * The weight of the product or person. + * + * @param QuantitativeValue|QuantitativeValue[] $weight + * + * @return static + * + * @see http://schema.org/weight + */ + public function weight($weight) + { + return $this->setProperty('weight', $weight); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ProfessionalService.php b/src/ProfessionalService.php index 119053807..684529fcf 100644 --- a/src/ProfessionalService.php +++ b/src/ProfessionalService.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Original definition: "provider of professional services." * @@ -17,8 +22,1328 @@ * * @see http://schema.org/ProfessionalService * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class ProfessionalService extends BaseType +class ProfessionalService extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ProfilePage.php b/src/ProfilePage.php index 2f3f30e50..d6722db31 100644 --- a/src/ProfilePage.php +++ b/src/ProfilePage.php @@ -2,13 +2,1691 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web page type: Profile page. * * @see http://schema.org/ProfilePage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class ProfilePage extends BaseType +class ProfilePage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ProgramMembership.php b/src/ProgramMembership.php index 34af76144..3e5075fc2 100644 --- a/src/ProgramMembership.php +++ b/src/ProgramMembership.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Used to describe membership in a loyalty programs (e.g. "StarAliance"), * traveler clubs (e.g. "AAA"), purchase clubs ("Safeway Club"), etc. * * @see http://schema.org/ProgramMembership * - * @mixin \Spatie\SchemaOrg\Intangible */ -class ProgramMembership extends BaseType +class ProgramMembership extends BaseType implements IntangibleContract, ThingContract { /** * The organization (airline, travelers' club, etc.) the membership is made @@ -84,4 +86,190 @@ public function programName($programName) return $this->setProperty('programName', $programName); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PropertyValue.php b/src/PropertyValue.php index ebcacb3ac..6f060cfbd 100644 --- a/src/PropertyValue.php +++ b/src/PropertyValue.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A property-value pair, e.g. representing a feature of a product or place. Use * the 'name' property for the name of the property. If there is an additional @@ -14,9 +18,8 @@ * * @see http://schema.org/PropertyValue * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class PropertyValue extends BaseType +class PropertyValue extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The upper value of some characteristic or property. @@ -140,4 +143,190 @@ public function valueReference($valueReference) return $this->setProperty('valueReference', $valueReference); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PropertyValueSpecification.php b/src/PropertyValueSpecification.php index d0480918c..69050fc1d 100644 --- a/src/PropertyValueSpecification.php +++ b/src/PropertyValueSpecification.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Property value specification. * * @see http://schema.org/PropertyValueSpecification * - * @mixin \Spatie\SchemaOrg\Intangible */ -class PropertyValueSpecification extends BaseType +class PropertyValueSpecification extends BaseType implements IntangibleContract, ThingContract { /** * The default value of the input. For properties that expect a literal, @@ -174,4 +176,190 @@ public function valueRequired($valueRequired) return $this->setProperty('valueRequired', $valueRequired); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PublicSwimmingPool.php b/src/PublicSwimmingPool.php index 9d337cd2b..c9e133f4b 100644 --- a/src/PublicSwimmingPool.php +++ b/src/PublicSwimmingPool.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A public swimming pool. * * @see http://schema.org/PublicSwimmingPool * - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class PublicSwimmingPool extends BaseType +class PublicSwimmingPool extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/PublicationEvent.php b/src/PublicationEvent.php index 16ec1eb96..ac9d7462b 100644 --- a/src/PublicationEvent.php +++ b/src/PublicationEvent.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A PublicationEvent corresponds indifferently to the event of publication for * a CreativeWork of any type e.g. a broadcast event, an on-demand event, a @@ -9,9 +12,8 @@ * * @see http://schema.org/PublicationEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class PublicationEvent extends BaseType +class PublicationEvent extends BaseType implements EventContract, ThingContract { /** * A flag to signal that the item, event, or place is accessible for free. @@ -55,4 +57,715 @@ public function publishedOn($publishedOn) return $this->setProperty('publishedOn', $publishedOn); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PublicationIssue.php b/src/PublicationIssue.php index b7ee5340e..b6ee5a053 100644 --- a/src/PublicationIssue.php +++ b/src/PublicationIssue.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A part of a successively published publication such as a periodical or * publication volume, often numbered, usually containing a grouping of works @@ -12,9 +15,8 @@ * * @see http://schema.org/PublicationIssue * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class PublicationIssue extends BaseType +class PublicationIssue extends BaseType implements CreativeWorkContract, ThingContract { /** * Identifies the issue of publication; for example, "iii" or "2". @@ -73,4 +75,1509 @@ public function pagination($pagination) return $this->setProperty('pagination', $pagination); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/PublicationVolume.php b/src/PublicationVolume.php index 8078c751f..06e2e6635 100644 --- a/src/PublicationVolume.php +++ b/src/PublicationVolume.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A part of a successively published publication such as a periodical or * multi-volume work, often numbered. It may represent a time span, such as a @@ -12,9 +15,8 @@ * * @see http://schema.org/PublicationVolume * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class PublicationVolume extends BaseType +class PublicationVolume extends BaseType implements CreativeWorkContract, ThingContract { /** * The page on which the work ends; for example "138" or "xvi". @@ -74,4 +76,1509 @@ public function volumeNumber($volumeNumber) return $this->setProperty('volumeNumber', $volumeNumber); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/QAPage.php b/src/QAPage.php index 00bc1ce65..c4809b40d 100644 --- a/src/QAPage.php +++ b/src/QAPage.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A QAPage is a WebPage focussed on a specific Question and its Answer(s), e.g. * in a question answering site or documenting Frequently Asked Questions @@ -9,8 +13,1682 @@ * * @see http://schema.org/QAPage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class QAPage extends BaseType +class QAPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/QualitativeValue.php b/src/QualitativeValue.php index 780995599..24a6e982c 100644 --- a/src/QualitativeValue.php +++ b/src/QualitativeValue.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A predefined value for a product characteristic, e.g. the power cord plug * type 'US' or the garment sizes 'S', 'M', 'L', and 'XL'. * * @see http://schema.org/QualitativeValue * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class QualitativeValue extends BaseType +class QualitativeValue extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * A property-value pair representing an additional characteristics of the @@ -139,4 +142,190 @@ public function valueReference($valueReference) return $this->setProperty('valueReference', $valueReference); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/QuantitativeValue.php b/src/QuantitativeValue.php index a9acd980f..877a020e6 100644 --- a/src/QuantitativeValue.php +++ b/src/QuantitativeValue.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A point value or interval for product characteristics and other purposes. * * @see http://schema.org/QuantitativeValue * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class QuantitativeValue extends BaseType +class QuantitativeValue extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * A property-value pair representing an additional characteristics of the @@ -131,4 +134,190 @@ public function valueReference($valueReference) return $this->setProperty('valueReference', $valueReference); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/QuantitativeValueDistribution.php b/src/QuantitativeValueDistribution.php index d9e291da2..49d1585ae 100644 --- a/src/QuantitativeValueDistribution.php +++ b/src/QuantitativeValueDistribution.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A statistical distribution of values. * * @see http://schema.org/QuantitativeValueDistribution * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class QuantitativeValueDistribution extends BaseType +class QuantitativeValueDistribution extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The median value. @@ -81,4 +84,190 @@ public function percentile90($percentile90) return $this->setProperty('percentile90', $percentile90); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Quantity.php b/src/Quantity.php index 292b02bc3..b2cccbc1d 100644 --- a/src/Quantity.php +++ b/src/Quantity.php @@ -2,14 +2,202 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Quantities such as distance, time, mass, weight, etc. Particular instances of * say Mass are entities like '3 Kg' or '4 milligrams'. * * @see http://schema.org/Quantity * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Quantity extends BaseType +class Quantity extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Question.php b/src/Question.php index 79c3a515c..401fa3999 100644 --- a/src/Question.php +++ b/src/Question.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A specific question - e.g. from a user seeking answers online, or collected * in a Frequently Asked Questions (FAQ) document. * * @see http://schema.org/Question * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Question extends BaseType +class Question extends BaseType implements CreativeWorkContract, ThingContract { /** * The answer(s) that has been accepted as best, typically on a @@ -87,4 +89,1509 @@ public function upvoteCount($upvoteCount) return $this->setProperty('upvoteCount', $upvoteCount); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/QuoteAction.php b/src/QuoteAction.php index 9adaab831..2022df6f1 100644 --- a/src/QuoteAction.php +++ b/src/QuoteAction.php @@ -2,14 +2,457 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent quotes/estimates/appraises an object/product/service with a price at * a location/store. * * @see http://schema.org/QuoteAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class QuoteAction extends BaseType +class QuoteAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RVPark.php b/src/RVPark.php index 6dffb376e..7f028df71 100644 --- a/src/RVPark.php +++ b/src/RVPark.php @@ -2,14 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A place offering space for "Recreational Vehicles", Caravans, mobile homes * and the like. * * @see http://schema.org/RVPark * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class RVPark extends BaseType +class RVPark extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RadioChannel.php b/src/RadioChannel.php index c163fabe5..d9d059559 100644 --- a/src/RadioChannel.php +++ b/src/RadioChannel.php @@ -2,14 +2,291 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BroadcastChannelContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A unique instance of a radio BroadcastService on a CableOrSatelliteService * lineup. * * @see http://schema.org/RadioChannel * - * @mixin \Spatie\SchemaOrg\BroadcastChannel */ -class RadioChannel extends BaseType +class RadioChannel extends BaseType implements BroadcastChannelContract, IntangibleContract, ThingContract { + /** + * The unique address by which the BroadcastService can be identified in a + * provider lineup. In US, this is typically a number. + * + * @param string|string[] $broadcastChannelId + * + * @return static + * + * @see http://schema.org/broadcastChannelId + */ + public function broadcastChannelId($broadcastChannelId) + { + return $this->setProperty('broadcastChannelId', $broadcastChannelId); + } + + /** + * The frequency used for over-the-air broadcasts. Numeric values or simple + * ranges e.g. 87-99. In addition a shortcut idiom is supported for + * frequences of AM and FM radio channels, e.g. "87 FM". + * + * @param BroadcastFrequencySpecification|BroadcastFrequencySpecification[]|string|string[] $broadcastFrequency + * + * @return static + * + * @see http://schema.org/broadcastFrequency + */ + public function broadcastFrequency($broadcastFrequency) + { + return $this->setProperty('broadcastFrequency', $broadcastFrequency); + } + + /** + * The type of service required to have access to the channel (e.g. Standard + * or Premium). + * + * @param string|string[] $broadcastServiceTier + * + * @return static + * + * @see http://schema.org/broadcastServiceTier + */ + public function broadcastServiceTier($broadcastServiceTier) + { + return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RadioClip.php b/src/RadioClip.php index 046749c78..4dc21b08b 100644 --- a/src/RadioClip.php +++ b/src/RadioClip.php @@ -2,13 +2,1653 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ClipContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A short radio program or a segment/part of a radio program. * * @see http://schema.org/RadioClip * - * @mixin \Spatie\SchemaOrg\Clip */ -class RadioClip extends BaseType +class RadioClip extends BaseType implements ClipContract, CreativeWorkContract, ThingContract { + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RadioEpisode.php b/src/RadioEpisode.php index 595e8a198..84c375968 100644 --- a/src/RadioEpisode.php +++ b/src/RadioEpisode.php @@ -2,13 +2,1668 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EpisodeContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A radio episode which can be part of a series or season. * * @see http://schema.org/RadioEpisode * - * @mixin \Spatie\SchemaOrg\Episode */ -class RadioEpisode extends BaseType +class RadioEpisode extends BaseType implements EpisodeContract, CreativeWorkContract, ThingContract { + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * Position of the episode within an ordered group of episodes. + * + * @param int|int[]|string|string[] $episodeNumber + * + * @return static + * + * @see http://schema.org/episodeNumber + */ + public function episodeNumber($episodeNumber) + { + return $this->setProperty('episodeNumber', $episodeNumber); + } + + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RadioSeason.php b/src/RadioSeason.php index dd4c40e39..45dc61276 100644 --- a/src/RadioSeason.php +++ b/src/RadioSeason.php @@ -2,13 +2,1682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeasonContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Season dedicated to radio broadcast and associated online delivery. * * @see http://schema.org/RadioSeason * - * @mixin \Spatie\SchemaOrg\CreativeWorkSeason */ -class RadioSeason extends BaseType +class RadioSeason extends BaseType implements CreativeWorkSeasonContract, CreativeWorkContract, ThingContract { + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An episode of a tv, radio or game media within a series or season. + * + * @param Episode|Episode[] $episode + * + * @return static + * + * @see http://schema.org/episode + */ + public function episode($episode) + { + return $this->setProperty('episode', $episode); + } + + /** + * An episode of a TV/radio series or season. + * + * @param Episode|Episode[] $episodes + * + * @return static + * + * @see http://schema.org/episodes + */ + public function episodes($episodes) + { + return $this->setProperty('episodes', $episodes); + } + + /** + * The number of episodes in this season or series. + * + * @param int|int[] $numberOfEpisodes + * + * @return static + * + * @see http://schema.org/numberOfEpisodes + */ + public function numberOfEpisodes($numberOfEpisodes) + { + return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * Position of the season within an ordered group of seasons. + * + * @param int|int[]|string|string[] $seasonNumber + * + * @return static + * + * @see http://schema.org/seasonNumber + */ + public function seasonNumber($seasonNumber) + { + return $this->setProperty('seasonNumber', $seasonNumber); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RadioSeries.php b/src/RadioSeries.php index e7b1682ef..abcc822fe 100644 --- a/src/RadioSeries.php +++ b/src/RadioSeries.php @@ -2,15 +2,20 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * CreativeWorkSeries dedicated to radio broadcast and associated online * delivery. * * @see http://schema.org/RadioSeries * - * @mixin \Spatie\SchemaOrg\CreativeWorkSeries */ -class RadioSeries extends BaseType +class RadioSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -215,4 +220,1571 @@ public function trailer($trailer) return $this->setProperty('trailer', $trailer); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + } diff --git a/src/RadioStation.php b/src/RadioStation.php index 257047e5a..10817e806 100644 --- a/src/RadioStation.php +++ b/src/RadioStation.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A radio station. * * @see http://schema.org/RadioStation * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class RadioStation extends BaseType +class RadioStation extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Rating.php b/src/Rating.php index 7e4d97e51..0080d9e05 100644 --- a/src/Rating.php +++ b/src/Rating.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A rating is an evaluation on a numeric scale, such as 1 to 5 stars. * * @see http://schema.org/Rating * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Rating extends BaseType +class Rating extends BaseType implements IntangibleContract, ThingContract { /** * The author of this content or rating. Please note that author is special @@ -93,4 +95,190 @@ public function worstRating($worstRating) return $this->setProperty('worstRating', $worstRating); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReactAction.php b/src/ReactAction.php index 11a11fd9e..043cc364e 100644 --- a/src/ReactAction.php +++ b/src/ReactAction.php @@ -2,14 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of responding instinctively and emotionally to an object, expressing * a sentiment. * * @see http://schema.org/ReactAction * - * @mixin \Spatie\SchemaOrg\AssessAction */ -class ReactAction extends BaseType +class ReactAction extends BaseType implements AssessActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReadAction.php b/src/ReadAction.php index 204f5c0c7..7f01d5cf4 100644 --- a/src/ReadAction.php +++ b/src/ReadAction.php @@ -2,13 +2,413 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of consuming written content. * * @see http://schema.org/ReadAction * - * @mixin \Spatie\SchemaOrg\ConsumeAction */ -class ReadAction extends BaseType +class ReadAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RealEstateAgent.php b/src/RealEstateAgent.php index 1064e6837..3305e100f 100644 --- a/src/RealEstateAgent.php +++ b/src/RealEstateAgent.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A real-estate agent. * * @see http://schema.org/RealEstateAgent * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class RealEstateAgent extends BaseType +class RealEstateAgent extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ReceiveAction.php b/src/ReceiveAction.php index 710301165..23dee9d98 100644 --- a/src/ReceiveAction.php +++ b/src/ReceiveAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of physically/electronically taking delivery of an object thathas * been transferred from an origin to a destination. Reciprocal of SendAction. @@ -15,9 +19,8 @@ * * @see http://schema.org/ReceiveAction * - * @mixin \Spatie\SchemaOrg\TransferAction */ -class ReceiveAction extends BaseType +class ReceiveAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** * A sub property of instrument. The method of delivery. @@ -48,4 +51,399 @@ public function sender($sender) return $this->setProperty('sender', $sender); } + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Recipe.php b/src/Recipe.php index ac4e29788..c3d7cb491 100644 --- a/src/Recipe.php +++ b/src/Recipe.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HowToContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A recipe. For dietary restrictions covered by the recipe, a few common * restrictions are enumerated via [[suitableForDiet]]. The [[keywords]] @@ -9,9 +13,8 @@ * * @see http://schema.org/Recipe * - * @mixin \Spatie\SchemaOrg\HowTo */ -class Recipe extends BaseType +class Recipe extends BaseType implements HowToContract, CreativeWorkContract, ThingContract { /** * The time it takes to actually cook the dish, in [ISO 8601 duration @@ -157,4 +160,1647 @@ public function suitableForDiet($suitableForDiet) return $this->setProperty('suitableForDiet', $suitableForDiet); } + /** + * The estimated cost of the supply or supplies consumed when performing + * instructions. + * + * @param MonetaryAmount|MonetaryAmount[]|string|string[] $estimatedCost + * + * @return static + * + * @see http://schema.org/estimatedCost + */ + public function estimatedCost($estimatedCost) + { + return $this->setProperty('estimatedCost', $estimatedCost); + } + + /** + * The length of time it takes to perform instructions or a direction (not + * including time to prepare the supplies), in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $performTime + * + * @return static + * + * @see http://schema.org/performTime + */ + public function performTime($performTime) + { + return $this->setProperty('performTime', $performTime); + } + + /** + * The length of time it takes to prepare the items to be used in + * instructions or a direction, in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $prepTime + * + * @return static + * + * @see http://schema.org/prepTime + */ + public function prepTime($prepTime) + { + return $this->setProperty('prepTime', $prepTime); + } + + /** + * A single step item (as HowToStep, text, document, video, etc.) or a + * HowToSection. + * + * @param CreativeWork|CreativeWork[]|HowToSection|HowToSection[]|HowToStep|HowToStep[]|string|string[] $step + * + * @return static + * + * @see http://schema.org/step + */ + public function step($step) + { + return $this->setProperty('step', $step); + } + + /** + * A single step item (as HowToStep, text, document, video, etc.) or a + * HowToSection (originally misnamed 'steps'; 'step' is preferred). + * + * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $steps + * + * @return static + * + * @see http://schema.org/steps + */ + public function steps($steps) + { + return $this->setProperty('steps', $steps); + } + + /** + * A sub-property of instrument. A supply consumed when performing + * instructions or a direction. + * + * @param HowToSupply|HowToSupply[]|string|string[] $supply + * + * @return static + * + * @see http://schema.org/supply + */ + public function supply($supply) + { + return $this->setProperty('supply', $supply); + } + + /** + * A sub property of instrument. An object used (but not consumed) when + * performing instructions or a direction. + * + * @param HowToTool|HowToTool[]|string|string[] $tool + * + * @return static + * + * @see http://schema.org/tool + */ + public function tool($tool) + { + return $this->setProperty('tool', $tool); + } + + /** + * The total time required to perform instructions or a direction (including + * time to prepare the supplies), in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $totalTime + * + * @return static + * + * @see http://schema.org/totalTime + */ + public function totalTime($totalTime) + { + return $this->setProperty('totalTime', $totalTime); + } + + /** + * The quantity that results by performing instructions. For example, a + * paper airplane, 10 personalized candles. + * + * @param QuantitativeValue|QuantitativeValue[]|string|string[] $yield + * + * @return static + * + * @see http://schema.org/yield + */ + public function yield($yield) + { + return $this->setProperty('yield', $yield); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RecyclingCenter.php b/src/RecyclingCenter.php index fb6b985f4..0784ee76e 100644 --- a/src/RecyclingCenter.php +++ b/src/RecyclingCenter.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A recycling center. * * @see http://schema.org/RecyclingCenter * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class RecyclingCenter extends BaseType +class RecyclingCenter extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/RegisterAction.php b/src/RegisterAction.php index 3b83d9d96..e20301823 100644 --- a/src/RegisterAction.php +++ b/src/RegisterAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of registering to be a user of a service, product or web page. * @@ -16,8 +20,372 @@ * * @see http://schema.org/RegisterAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class RegisterAction extends BaseType +class RegisterAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RejectAction.php b/src/RejectAction.php index 4b7d5d3cc..e108ca459 100644 --- a/src/RejectAction.php +++ b/src/RejectAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AllocateActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of rejecting to/adopting an object. * @@ -11,8 +16,372 @@ * * @see http://schema.org/RejectAction * - * @mixin \Spatie\SchemaOrg\AllocateAction */ -class RejectAction extends BaseType +class RejectAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RentAction.php b/src/RentAction.php index cd5ba5883..f9ee9644f 100644 --- a/src/RentAction.php +++ b/src/RentAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of giving money in return for temporary use, but not ownership, of an * object such as a vehicle or property. For example, an agent rents a property @@ -9,9 +13,8 @@ * * @see http://schema.org/RentAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class RentAction extends BaseType +class RentAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** * A sub property of participant. The owner of the real estate property. @@ -42,4 +45,444 @@ public function realEstateAgent($realEstateAgent) return $this->setProperty('realEstateAgent', $realEstateAgent); } + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RentalCarReservation.php b/src/RentalCarReservation.php index d693f9fab..ef94f1f84 100644 --- a/src/RentalCarReservation.php +++ b/src/RentalCarReservation.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservation for a rental car. * @@ -11,9 +15,8 @@ * * @see http://schema.org/RentalCarReservation * - * @mixin \Spatie\SchemaOrg\Reservation */ -class RentalCarReservation extends BaseType +class RentalCarReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** * Where a rental car can be dropped off. @@ -71,4 +74,396 @@ public function pickupTime($pickupTime) return $this->setProperty('pickupTime', $pickupTime); } + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReplaceAction.php b/src/ReplaceAction.php index 375ca3201..485769a57 100644 --- a/src/ReplaceAction.php +++ b/src/ReplaceAction.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of editing a recipient by replacing an old object with a new object. * * @see http://schema.org/ReplaceAction * - * @mixin \Spatie\SchemaOrg\UpdateAction */ -class ReplaceAction extends BaseType +class ReplaceAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract { /** * A sub property of object. The object that is being replaced. @@ -39,4 +42,397 @@ public function replacer($replacer) return $this->setProperty('replacer', $replacer); } + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $collection + * + * @return static + * + * @see http://schema.org/collection + */ + public function collection($collection) + { + return $this->setProperty('collection', $collection); + } + + /** + * A sub property of object. The collection target of the action. + * + * @param Thing|Thing[] $targetCollection + * + * @return static + * + * @see http://schema.org/targetCollection + */ + public function targetCollection($targetCollection) + { + return $this->setProperty('targetCollection', $targetCollection); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReplyAction.php b/src/ReplyAction.php index 2433b59ae..ed63de833 100644 --- a/src/ReplyAction.php +++ b/src/ReplyAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of responding to a question/message asked/sent by the object. Related * to [[AskAction]] @@ -12,9 +17,8 @@ * * @see http://schema.org/ReplyAction * - * @mixin \Spatie\SchemaOrg\CommunicateAction */ -class ReplyAction extends BaseType +class ReplyAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** * A sub property of result. The Comment created or sent as a result of this @@ -31,4 +35,429 @@ public function resultComment($resultComment) return $this->setProperty('resultComment', $resultComment); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Report.php b/src/Report.php index 2f34e110e..5edbbd875 100644 --- a/src/Report.php +++ b/src/Report.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Report generated by governmental or non-governmental organization. * * @see http://schema.org/Report * - * @mixin \Spatie\SchemaOrg\Article */ -class Report extends BaseType +class Report extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { /** * The number or other unique designator assigned to a Report by the @@ -26,4 +29,1634 @@ public function reportNumber($reportNumber) return $this->setProperty('reportNumber', $reportNumber); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Reservation.php b/src/Reservation.php index 9d6e538f6..d8b65a7c4 100644 --- a/src/Reservation.php +++ b/src/Reservation.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Describes a reservation for travel, dining or an event. Some reservations * require tickets. @@ -13,9 +16,8 @@ * * @see http://schema.org/Reservation * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Reservation extends BaseType +class Reservation extends BaseType implements IntangibleContract, ThingContract { /** * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as @@ -223,4 +225,190 @@ public function underName($underName) return $this->setProperty('underName', $underName); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReservationPackage.php b/src/ReservationPackage.php index f10314bd2..1798d1e86 100644 --- a/src/ReservationPackage.php +++ b/src/ReservationPackage.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A group of multiple reservations with common values for all sub-reservations. * * @see http://schema.org/ReservationPackage * - * @mixin \Spatie\SchemaOrg\Reservation */ -class ReservationPackage extends BaseType +class ReservationPackage extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** * The airline-specific indicator of boarding order / preference. @@ -40,4 +43,396 @@ public function subReservation($subReservation) return $this->setProperty('subReservation', $subReservation); } + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReservationStatusType.php b/src/ReservationStatusType.php index 14fbb5ced..a3b5da34c 100644 --- a/src/ReservationStatusType.php +++ b/src/ReservationStatusType.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Enumerated status values for Reservation. * * @see http://schema.org/ReservationStatusType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class ReservationStatusType extends BaseType +class ReservationStatusType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * The status for a previously confirmed reservation that is now cancelled. @@ -41,4 +44,190 @@ class ReservationStatusType extends BaseType */ const ReservationPending = 'http://schema.org/ReservationPending'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReserveAction.php b/src/ReserveAction.php index ab403f7eb..db1403c8f 100644 --- a/src/ReserveAction.php +++ b/src/ReserveAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlanActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Reserving a concrete object. * @@ -13,8 +18,386 @@ * * @see http://schema.org/ReserveAction * - * @mixin \Spatie\SchemaOrg\PlanAction */ -class ReserveAction extends BaseType +class ReserveAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract { + /** + * The time the object is scheduled to. + * + * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime + * + * @return static + * + * @see http://schema.org/scheduledTime + */ + public function scheduledTime($scheduledTime) + { + return $this->setProperty('scheduledTime', $scheduledTime); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Reservoir.php b/src/Reservoir.php index 89166511a..24fa81c33 100644 --- a/src/Reservoir.php +++ b/src/Reservoir.php @@ -2,14 +2,684 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BodyOfWaterContract; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservoir of water, typically an artificially created lake, like the Lake * Kariba reservoir. * * @see http://schema.org/Reservoir * - * @mixin \Spatie\SchemaOrg\BodyOfWater */ -class Reservoir extends BaseType +class Reservoir extends BaseType implements BodyOfWaterContract, LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Residence.php b/src/Residence.php index 455523c86..9e628db18 100644 --- a/src/Residence.php +++ b/src/Residence.php @@ -2,13 +2,681 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The place where a person lives. * * @see http://schema.org/Residence * - * @mixin \Spatie\SchemaOrg\Place */ -class Residence extends BaseType +class Residence extends BaseType implements PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Resort.php b/src/Resort.php index 5aa9f4296..616f31239 100644 --- a/src/Resort.php +++ b/src/Resort.php @@ -2,6 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A resort is a place used for relaxation or recreation, attracting visitors * for holidays or vacations. Resorts are places, towns or sometimes commercial @@ -14,8 +20,1435 @@ * * @see http://schema.org/Resort * - * @mixin \Spatie\SchemaOrg\LodgingBusiness */ -class Resort extends BaseType +class Resort extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * + * @param Language|Language[]|string|string[] $availableLanguage + * + * @return static + * + * @see http://schema.org/availableLanguage + */ + public function availableLanguage($availableLanguage) + { + return $this->setProperty('availableLanguage', $availableLanguage); + } + + /** + * The earliest someone may check into a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * + * @return static + * + * @see http://schema.org/checkinTime + */ + public function checkinTime($checkinTime) + { + return $this->setProperty('checkinTime', $checkinTime); + } + + /** + * The latest someone may check out of a lodging establishment. + * + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * + * @return static + * + * @see http://schema.org/checkoutTime + */ + public function checkoutTime($checkoutTime) + { + return $this->setProperty('checkoutTime', $checkoutTime); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Restaurant.php b/src/Restaurant.php index c5f9b4c5e..285d0f847 100644 --- a/src/Restaurant.php +++ b/src/Restaurant.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A restaurant. * * @see http://schema.org/Restaurant * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class Restaurant extends BaseType +class Restaurant extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/RestrictedDiet.php b/src/RestrictedDiet.php index 03b234475..976cc4aea 100644 --- a/src/RestrictedDiet.php +++ b/src/RestrictedDiet.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A diet restricted to certain foods or preparations for cultural, religious, * health or lifestyle reasons. * * @see http://schema.org/RestrictedDiet * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class RestrictedDiet extends BaseType +class RestrictedDiet extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * A diet appropriate for people with diabetes. @@ -89,4 +92,190 @@ class RestrictedDiet extends BaseType */ const VegetarianDiet = 'http://schema.org/VegetarianDiet'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ResumeAction.php b/src/ResumeAction.php index 2509c965c..0cf88bc88 100644 --- a/src/ResumeAction.php +++ b/src/ResumeAction.php @@ -2,14 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ControlActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of resuming a device or application which was formerly paused (e.g. * resume music playback or resume a timer). * * @see http://schema.org/ResumeAction * - * @mixin \Spatie\SchemaOrg\ControlAction */ -class ResumeAction extends BaseType +class ResumeAction extends BaseType implements ControlActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReturnAction.php b/src/ReturnAction.php index 5524f5a00..174cf0d1a 100644 --- a/src/ReturnAction.php +++ b/src/ReturnAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of returning to the origin that which was previously received * (concrete objects) or taken (ownership). * * @see http://schema.org/ReturnAction * - * @mixin \Spatie\SchemaOrg\TransferAction */ -class ReturnAction extends BaseType +class ReturnAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** * A sub property of participant. The participant who is at the receiving @@ -27,4 +30,399 @@ public function recipient($recipient) return $this->setProperty('recipient', $recipient); } + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Review.php b/src/Review.php index 1eecf956f..71f9c1e34 100644 --- a/src/Review.php +++ b/src/Review.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A review of an item - for example, of a restaurant, movie, or store. * * @see http://schema.org/Review * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Review extends BaseType +class Review extends BaseType implements CreativeWorkContract, ThingContract { /** * The item that is being reviewed/rated. @@ -71,4 +73,1509 @@ public function reviewRating($reviewRating) return $this->setProperty('reviewRating', $reviewRating); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ReviewAction.php b/src/ReviewAction.php index 8e4f63ab3..0d71289c0 100644 --- a/src/ReviewAction.php +++ b/src/ReviewAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of producing a balanced opinion about the object for an audience. An * agent reviews an object with participants resulting in a review. * * @see http://schema.org/ReviewAction * - * @mixin \Spatie\SchemaOrg\AssessAction */ -class ReviewAction extends BaseType +class ReviewAction extends BaseType implements AssessActionContract, ActionContract, ThingContract { /** * A sub property of result. The review that resulted in the performing of @@ -27,4 +30,369 @@ public function resultReview($resultReview) return $this->setProperty('resultReview', $resultReview); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RiverBodyOfWater.php b/src/RiverBodyOfWater.php index 43f792528..c5e173d16 100644 --- a/src/RiverBodyOfWater.php +++ b/src/RiverBodyOfWater.php @@ -2,13 +2,683 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BodyOfWaterContract; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A river (for example, the broad majestic Shannon). * * @see http://schema.org/RiverBodyOfWater * - * @mixin \Spatie\SchemaOrg\BodyOfWater */ -class RiverBodyOfWater extends BaseType +class RiverBodyOfWater extends BaseType implements BodyOfWaterContract, LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Role.php b/src/Role.php index 26f78155b..5e6f3e6bc 100644 --- a/src/Role.php +++ b/src/Role.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Represents additional information about a relationship or property. For * example a Role can be used to say that a 'member' role linking some @@ -14,9 +17,8 @@ * * @see http://schema.org/Role * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Role extends BaseType +class Role extends BaseType implements IntangibleContract, ThingContract { /** * The end date and time of the item (in [ISO 8601 date @@ -81,4 +83,190 @@ public function startDate($startDate) return $this->setProperty('startDate', $startDate); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RoofingContractor.php b/src/RoofingContractor.php index db6187117..7de1c0499 100644 --- a/src/RoofingContractor.php +++ b/src/RoofingContractor.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HomeAndConstructionBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A roofing contractor. * * @see http://schema.org/RoofingContractor * - * @mixin \Spatie\SchemaOrg\HomeAndConstructionBusiness */ -class RoofingContractor extends BaseType +class RoofingContractor extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Room.php b/src/Room.php index 05bf311e6..215214057 100644 --- a/src/Room.php +++ b/src/Room.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A room is a distinguishable space within a structure, usually separated from * other spaces by interior walls. (Source: Wikipedia, the free encyclopedia, @@ -13,8 +17,735 @@ * * @see http://schema.org/Room * - * @mixin \Spatie\SchemaOrg\Accommodation */ -class Room extends BaseType +class Room extends BaseType implements AccommodationContract, PlaceContract, ThingContract { + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indications regarding the permitted usage of the accommodation. + * + * @param string|string[] $permittedUsage + * + * @return static + * + * @see http://schema.org/permittedUsage + */ + public function permittedUsage($permittedUsage) + { + return $this->setProperty('permittedUsage', $permittedUsage); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RsvpAction.php b/src/RsvpAction.php index 4b50097d1..7d8d01a7c 100644 --- a/src/RsvpAction.php +++ b/src/RsvpAction.php @@ -2,15 +2,20 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InformActionContract; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of notifying an event organizer as to whether you expect to attend * the event. * * @see http://schema.org/RsvpAction * - * @mixin \Spatie\SchemaOrg\InformAction */ -class RsvpAction extends BaseType +class RsvpAction extends BaseType implements InformActionContract, CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** * If responding yes, the number of guests who will attend in addition to @@ -55,4 +60,444 @@ public function rsvpResponse($rsvpResponse) return $this->setProperty('rsvpResponse', $rsvpResponse); } + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/RsvpResponseType.php b/src/RsvpResponseType.php index fe74c956a..f82c04c35 100644 --- a/src/RsvpResponseType.php +++ b/src/RsvpResponseType.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * RsvpResponseType is an enumeration type whose instances represent responding * to an RSVP request. * * @see http://schema.org/RsvpResponseType * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class RsvpResponseType extends BaseType +class RsvpResponseType extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { /** * The invitee may or may not attend. @@ -33,4 +36,190 @@ class RsvpResponseType extends BaseType */ const RsvpResponseYes = 'http://schema.org/RsvpResponseYes'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SaleEvent.php b/src/SaleEvent.php index baff0f613..84245d0ce 100644 --- a/src/SaleEvent.php +++ b/src/SaleEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Sales event. * * @see http://schema.org/SaleEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class SaleEvent extends BaseType +class SaleEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ScheduleAction.php b/src/ScheduleAction.php index 8899f2a06..8d7627995 100644 --- a/src/ScheduleAction.php +++ b/src/ScheduleAction.php @@ -2,6 +2,11 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlanActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Scheduling future actions, events, or tasks. * @@ -13,8 +18,386 @@ * * @see http://schema.org/ScheduleAction * - * @mixin \Spatie\SchemaOrg\PlanAction */ -class ScheduleAction extends BaseType +class ScheduleAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract { + /** + * The time the object is scheduled to. + * + * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime + * + * @return static + * + * @see http://schema.org/scheduledTime + */ + public function scheduledTime($scheduledTime) + { + return $this->setProperty('scheduledTime', $scheduledTime); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ScholarlyArticle.php b/src/ScholarlyArticle.php index d1985e486..8e8173671 100644 --- a/src/ScholarlyArticle.php +++ b/src/ScholarlyArticle.php @@ -2,13 +2,1646 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A scholarly article. * * @see http://schema.org/ScholarlyArticle * - * @mixin \Spatie\SchemaOrg\Article */ -class ScholarlyArticle extends BaseType +class ScholarlyArticle extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/School.php b/src/School.php index 32cabc95c..07b58274a 100644 --- a/src/School.php +++ b/src/School.php @@ -2,13 +2,952 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EducationalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A school. * * @see http://schema.org/School * - * @mixin \Spatie\SchemaOrg\EducationalOrganization */ -class School extends BaseType +class School extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ScreeningEvent.php b/src/ScreeningEvent.php index 3a9467558..45d6419fa 100644 --- a/src/ScreeningEvent.php +++ b/src/ScreeningEvent.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A screening of a movie or other video. * * @see http://schema.org/ScreeningEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class ScreeningEvent extends BaseType +class ScreeningEvent extends BaseType implements EventContract, ThingContract { /** * Languages in which subtitles/captions are available, in [IETF BCP 47 @@ -55,4 +57,715 @@ public function workPresented($workPresented) return $this->setProperty('workPresented', $workPresented); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Sculpture.php b/src/Sculpture.php index a5876847f..54a818ea7 100644 --- a/src/Sculpture.php +++ b/src/Sculpture.php @@ -2,13 +2,1520 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A piece of sculpture. * * @see http://schema.org/Sculpture * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Sculpture extends BaseType +class Sculpture extends BaseType implements CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SeaBodyOfWater.php b/src/SeaBodyOfWater.php index d7134f7ba..26655d8b5 100644 --- a/src/SeaBodyOfWater.php +++ b/src/SeaBodyOfWater.php @@ -2,13 +2,683 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BodyOfWaterContract; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A sea (for example, the Caspian sea). * * @see http://schema.org/SeaBodyOfWater * - * @mixin \Spatie\SchemaOrg\BodyOfWater */ -class SeaBodyOfWater extends BaseType +class SeaBodyOfWater extends BaseType implements BodyOfWaterContract, LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SearchAction.php b/src/SearchAction.php index 15c5309a1..a6556c4da 100644 --- a/src/SearchAction.php +++ b/src/SearchAction.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of searching for an object. * @@ -12,9 +15,8 @@ * * @see http://schema.org/SearchAction * - * @mixin \Spatie\SchemaOrg\Action */ -class SearchAction extends BaseType +class SearchAction extends BaseType implements ActionContract, ThingContract { /** * A sub property of instrument. The query used on this action. @@ -30,4 +32,369 @@ public function query($query) return $this->setProperty('query', $query); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SearchResultsPage.php b/src/SearchResultsPage.php index 8e6f9610e..847240786 100644 --- a/src/SearchResultsPage.php +++ b/src/SearchResultsPage.php @@ -2,13 +2,1691 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web page type: Search results page. * * @see http://schema.org/SearchResultsPage * - * @mixin \Spatie\SchemaOrg\WebPage */ -class SearchResultsPage extends BaseType +class SearchResultsPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Season.php b/src/Season.php index c84992fcd..90a4cc5d8 100644 --- a/src/Season.php +++ b/src/Season.php @@ -2,13 +2,1520 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A media season e.g. tv, radio, video game etc. * * @see http://schema.org/Season * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class Season extends BaseType +class Season extends BaseType implements CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Seat.php b/src/Seat.php index bb75c77c4..10c393dca 100644 --- a/src/Seat.php +++ b/src/Seat.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Used to describe a seat, such as a reserved seat in an event reservation. * * @see http://schema.org/Seat * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Seat extends BaseType +class Seat extends BaseType implements IntangibleContract, ThingContract { /** * The location of the reserved seat (e.g., 27). @@ -67,4 +69,190 @@ public function seatingType($seatingType) return $this->setProperty('seatingType', $seatingType); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SelfStorage.php b/src/SelfStorage.php index 89a4df1a9..9a031d0e8 100644 --- a/src/SelfStorage.php +++ b/src/SelfStorage.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A self-storage facility. * * @see http://schema.org/SelfStorage * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class SelfStorage extends BaseType +class SelfStorage extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/SellAction.php b/src/SellAction.php index 044f076a6..91459755a 100644 --- a/src/SellAction.php +++ b/src/SellAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of taking money from a buyer in exchange for goods or services * rendered. An agent sells an object, product, or service to a buyer for a @@ -9,9 +13,8 @@ * * @see http://schema.org/SellAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class SellAction extends BaseType +class SellAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** * A sub property of participant. The participant/person/organization that @@ -42,4 +45,444 @@ public function warrantyPromise($warrantyPromise) return $this->setProperty('warrantyPromise', $warrantyPromise); } + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SendAction.php b/src/SendAction.php index b4aa176e9..8f830fbae 100644 --- a/src/SendAction.php +++ b/src/SendAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of physically/electronically dispatching an object for transfer from * an origin to a destination.Related actions: @@ -13,9 +17,8 @@ * * @see http://schema.org/SendAction * - * @mixin \Spatie\SchemaOrg\TransferAction */ -class SendAction extends BaseType +class SendAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** * A sub property of instrument. The method of delivery. @@ -46,4 +49,399 @@ public function recipient($recipient) return $this->setProperty('recipient', $recipient); } + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Series.php b/src/Series.php index 10ef18259..03b94bf60 100644 --- a/src/Series.php +++ b/src/Series.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Series in schema.org is a group of related items, typically but not * necessarily of the same kind. See also [[CreativeWorkSeries]], @@ -9,9 +12,8 @@ * * @see http://schema.org/Series * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Series extends BaseType +class Series extends BaseType implements IntangibleContract, ThingContract { /** * A director of e.g. tv, radio, movie, video gaming etc. content, or of an @@ -29,4 +31,190 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Service.php b/src/Service.php index 9acaa3807..807e47b9d 100644 --- a/src/Service.php +++ b/src/Service.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A service provided by an organization, e.g. delivery service, print services, * etc. * * @see http://schema.org/Service * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Service extends BaseType +class Service extends BaseType implements IntangibleContract, ThingContract { /** * The overall rating, based on a collection of reviews or ratings, of the @@ -350,4 +352,190 @@ public function slogan($slogan) return $this->setProperty('slogan', $slogan); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ServiceChannel.php b/src/ServiceChannel.php index a1d9e1cff..89086919d 100644 --- a/src/ServiceChannel.php +++ b/src/ServiceChannel.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A means for accessing a service, e.g. a government office location, web site, * or phone number. * * @see http://schema.org/ServiceChannel * - * @mixin \Spatie\SchemaOrg\Intangible */ -class ServiceChannel extends BaseType +class ServiceChannel extends BaseType implements IntangibleContract, ThingContract { /** * A language someone may use with or at the item, service or place. Please @@ -127,4 +129,190 @@ public function serviceUrl($serviceUrl) return $this->setProperty('serviceUrl', $serviceUrl); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ShareAction.php b/src/ShareAction.php index 95d4c5522..14161ac60 100644 --- a/src/ShareAction.php +++ b/src/ShareAction.php @@ -2,13 +2,442 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of distributing content to people for their amusement or edification. * * @see http://schema.org/ShareAction * - * @mixin \Spatie\SchemaOrg\CommunicateAction */ -class ShareAction extends BaseType +class ShareAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A sub property of instrument. The language used on this action. + * + * @param Language|Language[] $language + * + * @return static + * + * @see http://schema.org/language + */ + public function language($language) + { + return $this->setProperty('language', $language); + } + + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ShoeStore.php b/src/ShoeStore.php index 23a120324..d02093240 100644 --- a/src/ShoeStore.php +++ b/src/ShoeStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A shoe store. * * @see http://schema.org/ShoeStore * - * @mixin \Spatie\SchemaOrg\Store */ -class ShoeStore extends BaseType +class ShoeStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ShoppingCenter.php b/src/ShoppingCenter.php index 45f8fb050..1521e4ff9 100644 --- a/src/ShoppingCenter.php +++ b/src/ShoppingCenter.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A shopping center or mall. * * @see http://schema.org/ShoppingCenter * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class ShoppingCenter extends BaseType +class ShoppingCenter extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/SingleFamilyResidence.php b/src/SingleFamilyResidence.php index b63bfe831..f7f2eab6c 100644 --- a/src/SingleFamilyResidence.php +++ b/src/SingleFamilyResidence.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HouseContract; +use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Residence type: Single-family home. * * @see http://schema.org/SingleFamilyResidence * - * @mixin \Spatie\SchemaOrg\House */ -class SingleFamilyResidence extends BaseType +class SingleFamilyResidence extends BaseType implements HouseContract, AccommodationContract, PlaceContract, ThingContract { /** * The number of rooms (excluding bathrooms and closets) of the @@ -46,4 +50,732 @@ public function occupancy($occupancy) return $this->setProperty('occupancy', $occupancy); } + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + + /** + * Indications regarding the permitted usage of the accommodation. + * + * @param string|string[] $permittedUsage + * + * @return static + * + * @see http://schema.org/permittedUsage + */ + public function permittedUsage($permittedUsage) + { + return $this->setProperty('permittedUsage', $permittedUsage); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SiteNavigationElement.php b/src/SiteNavigationElement.php index df9207e39..24dc07b88 100644 --- a/src/SiteNavigationElement.php +++ b/src/SiteNavigationElement.php @@ -2,13 +2,1521 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A navigation element of the page. * * @see http://schema.org/SiteNavigationElement * - * @mixin \Spatie\SchemaOrg\WebPageElement */ -class SiteNavigationElement extends BaseType +class SiteNavigationElement extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SkiResort.php b/src/SkiResort.php index df79d5f87..cc3b7b3e0 100644 --- a/src/SkiResort.php +++ b/src/SkiResort.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A ski resort. * * @see http://schema.org/SkiResort * - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class SkiResort extends BaseType +class SkiResort extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/SocialEvent.php b/src/SocialEvent.php index 9431899b7..fe8e03150 100644 --- a/src/SocialEvent.php +++ b/src/SocialEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Social event. * * @see http://schema.org/SocialEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class SocialEvent extends BaseType +class SocialEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SocialMediaPosting.php b/src/SocialMediaPosting.php index c037aed9f..e32d7ac0a 100644 --- a/src/SocialMediaPosting.php +++ b/src/SocialMediaPosting.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A post to a social media platform, including blog posts, tweets, Facebook * posts, etc. * * @see http://schema.org/SocialMediaPosting * - * @mixin \Spatie\SchemaOrg\Article */ -class SocialMediaPosting extends BaseType +class SocialMediaPosting extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { /** * A CreativeWork such as an image, video, or audio clip shared as part of @@ -27,4 +30,1634 @@ public function sharedContent($sharedContent) return $this->setProperty('sharedContent', $sharedContent); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SoftwareApplication.php b/src/SoftwareApplication.php index da4377079..e9503410c 100644 --- a/src/SoftwareApplication.php +++ b/src/SoftwareApplication.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A software application. * * @see http://schema.org/SoftwareApplication * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class SoftwareApplication extends BaseType +class SoftwareApplication extends BaseType implements CreativeWorkContract, ThingContract { /** * Type of software application, e.g. 'Game, Multimedia'. @@ -362,4 +364,1509 @@ public function supportingData($supportingData) return $this->setProperty('supportingData', $supportingData); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SoftwareSourceCode.php b/src/SoftwareSourceCode.php index 9030285e0..e96ee4cd7 100644 --- a/src/SoftwareSourceCode.php +++ b/src/SoftwareSourceCode.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Computer programming source code. Example: Full (compile ready) solutions, * code snippet samples, scripts, templates. * * @see http://schema.org/SoftwareSourceCode * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class SoftwareSourceCode extends BaseType +class SoftwareSourceCode extends BaseType implements CreativeWorkContract, ThingContract { /** * Link to the repository where the un-compiled, human readable code and @@ -116,4 +118,1509 @@ public function targetProduct($targetProduct) return $this->setProperty('targetProduct', $targetProduct); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SomeProducts.php b/src/SomeProducts.php index d1e420baf..a0ec6637e 100644 --- a/src/SomeProducts.php +++ b/src/SomeProducts.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ProductContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A placeholder for multiple similar products of the same kind. * * @see http://schema.org/SomeProducts * - * @mixin \Spatie\SchemaOrg\Product */ -class SomeProducts extends BaseType +class SomeProducts extends BaseType implements ProductContract, ThingContract { /** * The current approximate inventory level for the item or items. @@ -25,4 +27,724 @@ public function inventoryLevel($inventoryLevel) return $this->setProperty('inventoryLevel', $inventoryLevel); } + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * The color of the product. + * + * @param string|string[] $color + * + * @return static + * + * @see http://schema.org/color + */ + public function color($color) + { + return $this->setProperty('color', $color); + } + + /** + * The depth of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth + * + * @return static + * + * @see http://schema.org/depth + */ + public function depth($depth) + { + return $this->setProperty('depth', $depth); + } + + /** + * The GTIN-12 code of the product, or the product to which the offer + * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a + * U.P.C. Company Prefix, Item Reference, and Check Digit used to identify + * trade items. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin12 + * + * @return static + * + * @see http://schema.org/gtin12 + */ + public function gtin12($gtin12) + { + return $this->setProperty('gtin12', $gtin12); + } + + /** + * The GTIN-13 code of the product, or the product to which the offer + * refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former + * 12-digit UPC codes can be converted into a GTIN-13 code by simply adding + * a preceeding zero. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin13 + * + * @return static + * + * @see http://schema.org/gtin13 + */ + public function gtin13($gtin13) + { + return $this->setProperty('gtin13', $gtin13); + } + + /** + * The GTIN-14 code of the product, or the product to which the offer + * refers. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin14 + * + * @return static + * + * @see http://schema.org/gtin14 + */ + public function gtin14($gtin14) + { + return $this->setProperty('gtin14', $gtin14); + } + + /** + * The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of + * the product, or the product to which the offer refers. This code is also + * known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin8 + * + * @return static + * + * @see http://schema.org/gtin8 + */ + public function gtin8($gtin8) + { + return $this->setProperty('gtin8', $gtin8); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is an accessory or spare part. + * + * @param Product|Product[] $isAccessoryOrSparePartFor + * + * @return static + * + * @see http://schema.org/isAccessoryOrSparePartFor + */ + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor) + { + return $this->setProperty('isAccessoryOrSparePartFor', $isAccessoryOrSparePartFor); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is a consumable. + * + * @param Product|Product[] $isConsumableFor + * + * @return static + * + * @see http://schema.org/isConsumableFor + */ + public function isConsumableFor($isConsumableFor) + { + return $this->setProperty('isConsumableFor', $isConsumableFor); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * A predefined value from OfferItemCondition or a textual description of + * the condition of the product or service, or the products or services + * included in the offer. + * + * @param OfferItemCondition|OfferItemCondition[] $itemCondition + * + * @return static + * + * @see http://schema.org/itemCondition + */ + public function itemCondition($itemCondition) + { + return $this->setProperty('itemCondition', $itemCondition); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The manufacturer of the product. + * + * @param Organization|Organization[] $manufacturer + * + * @return static + * + * @see http://schema.org/manufacturer + */ + public function manufacturer($manufacturer) + { + return $this->setProperty('manufacturer', $manufacturer); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * The model of the product. Use with the URL of a ProductModel or a textual + * representation of the model identifier. The URL of the ProductModel can + * be from an external source. It is recommended to additionally provide + * strong product identifiers via the gtin8/gtin13/gtin14 and mpn + * properties. + * + * @param ProductModel|ProductModel[]|string|string[] $model + * + * @return static + * + * @see http://schema.org/model + */ + public function model($model) + { + return $this->setProperty('model', $model); + } + + /** + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. + * + * @param string|string[] $mpn + * + * @return static + * + * @see http://schema.org/mpn + */ + public function mpn($mpn) + { + return $this->setProperty('mpn', $mpn); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The product identifier, such as ISBN. For example: ``` meta + * itemprop="productID" content="isbn:123-456-789" ```. + * + * @param string|string[] $productID + * + * @return static + * + * @see http://schema.org/productID + */ + public function productID($productID) + { + return $this->setProperty('productID', $productID); + } + + /** + * The date of production of the item, e.g. vehicle. + * + * @param \DateTimeInterface|\DateTimeInterface[] $productionDate + * + * @return static + * + * @see http://schema.org/productionDate + */ + public function productionDate($productionDate) + { + return $this->setProperty('productionDate', $productionDate); + } + + /** + * The date the item e.g. vehicle was purchased by the current owner. + * + * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate + * + * @return static + * + * @see http://schema.org/purchaseDate + */ + public function purchaseDate($purchaseDate) + { + return $this->setProperty('purchaseDate', $purchaseDate); + } + + /** + * The release date of a product or product model. This can be used to + * distinguish the exact variant of a product. + * + * @param \DateTimeInterface|\DateTimeInterface[] $releaseDate + * + * @return static + * + * @see http://schema.org/releaseDate + */ + public function releaseDate($releaseDate) + { + return $this->setProperty('releaseDate', $releaseDate); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a + * product or service, or the product to which the offer refers. + * + * @param string|string[] $sku + * + * @return static + * + * @see http://schema.org/sku + */ + public function sku($sku) + { + return $this->setProperty('sku', $sku); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * The weight of the product or person. + * + * @param QuantitativeValue|QuantitativeValue[] $weight + * + * @return static + * + * @see http://schema.org/weight + */ + public function weight($weight) + { + return $this->setProperty('weight', $weight); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SpeakableSpecification.php b/src/SpeakableSpecification.php index 27eb89a92..24c655499 100644 --- a/src/SpeakableSpecification.php +++ b/src/SpeakableSpecification.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A SpeakableSpecification indicates (typically via [[xpath]] or * [[cssSelector]]) sections of a document that are highlighted as particularly @@ -10,10 +13,195 @@ * * @see http://schema.org/SpeakableSpecification * - * @mixin \Spatie\SchemaOrg\Intangible * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ -class SpeakableSpecification extends BaseType +class SpeakableSpecification extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Specialty.php b/src/Specialty.php index 933c3886b..a9cdbc51e 100644 --- a/src/Specialty.php +++ b/src/Specialty.php @@ -2,14 +2,203 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Any branch of a field in which people typically develop specific expertise, * usually after significant study, time, and effort. * * @see http://schema.org/Specialty * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class Specialty extends BaseType +class Specialty extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SportingGoodsStore.php b/src/SportingGoodsStore.php index 6e87e700b..0aa6dad09 100644 --- a/src/SportingGoodsStore.php +++ b/src/SportingGoodsStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A sporting goods store. * * @see http://schema.org/SportingGoodsStore * - * @mixin \Spatie\SchemaOrg\Store */ -class SportingGoodsStore extends BaseType +class SportingGoodsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/SportsActivityLocation.php b/src/SportsActivityLocation.php index 4ab581d55..36cf0113c 100644 --- a/src/SportsActivityLocation.php +++ b/src/SportsActivityLocation.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A sports location, such as a playing field. * * @see http://schema.org/SportsActivityLocation * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class SportsActivityLocation extends BaseType +class SportsActivityLocation extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/SportsClub.php b/src/SportsClub.php index af8604236..cb3923232 100644 --- a/src/SportsClub.php +++ b/src/SportsClub.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A sports club. * * @see http://schema.org/SportsClub * - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class SportsClub extends BaseType +class SportsClub extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/SportsEvent.php b/src/SportsEvent.php index 254f01ea2..8234a6fd3 100644 --- a/src/SportsEvent.php +++ b/src/SportsEvent.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Sports event. * * @see http://schema.org/SportsEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class SportsEvent extends BaseType +class SportsEvent extends BaseType implements EventContract, ThingContract { /** * The away team in a sports event. @@ -53,4 +55,715 @@ public function homeTeam($homeTeam) return $this->setProperty('homeTeam', $homeTeam); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SportsOrganization.php b/src/SportsOrganization.php index d9cea1884..daafebcd0 100644 --- a/src/SportsOrganization.php +++ b/src/SportsOrganization.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Represents the collection of all sports organizations, including sports * teams, governing bodies, and sports associations. * * @see http://schema.org/SportsOrganization * - * @mixin \Spatie\SchemaOrg\Organization */ -class SportsOrganization extends BaseType +class SportsOrganization extends BaseType implements OrganizationContract, ThingContract { /** * A type of sport (e.g. Baseball). @@ -26,4 +28,926 @@ public function sport($sport) return $this->setProperty('sport', $sport); } + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SportsTeam.php b/src/SportsTeam.php index 84832b6cc..3d536ff88 100644 --- a/src/SportsTeam.php +++ b/src/SportsTeam.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SportsOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Organization: Sports team. * * @see http://schema.org/SportsTeam * - * @mixin \Spatie\SchemaOrg\SportsOrganization */ -class SportsTeam extends BaseType +class SportsTeam extends BaseType implements SportsOrganizationContract, OrganizationContract, ThingContract { /** * A person that acts as performing member of a sports team; a player as @@ -40,4 +43,940 @@ public function coach($coach) return $this->setProperty('coach', $coach); } + /** + * A type of sport (e.g. Baseball). + * + * @param string|string[] $sport + * + * @return static + * + * @see http://schema.org/sport + */ + public function sport($sport) + { + return $this->setProperty('sport', $sport); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SpreadsheetDigitalDocument.php b/src/SpreadsheetDigitalDocument.php index 9d6000f51..83c152f0d 100644 --- a/src/SpreadsheetDigitalDocument.php +++ b/src/SpreadsheetDigitalDocument.php @@ -2,13 +2,1537 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A spreadsheet file. * * @see http://schema.org/SpreadsheetDigitalDocument * - * @mixin \Spatie\SchemaOrg\DigitalDocument */ -class SpreadsheetDigitalDocument extends BaseType +class SpreadsheetDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract { + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/StadiumOrArena.php b/src/StadiumOrArena.php index 71cfdaf15..b54154033 100644 --- a/src/StadiumOrArena.php +++ b/src/StadiumOrArena.php @@ -2,14 +2,1340 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A stadium. * * @see http://schema.org/StadiumOrArena * - * @mixin \Spatie\SchemaOrg\CivicStructure - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class StadiumOrArena extends BaseType +class StadiumOrArena extends BaseType implements CivicStructureContract, SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + } diff --git a/src/State.php b/src/State.php index 92d210e17..398776517 100644 --- a/src/State.php +++ b/src/State.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A state or province of a country. * * @see http://schema.org/State * - * @mixin \Spatie\SchemaOrg\AdministrativeArea */ -class State extends BaseType +class State extends BaseType implements AdministrativeAreaContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SteeringPositionValue.php b/src/SteeringPositionValue.php index ed598742e..7a3bdae48 100644 --- a/src/SteeringPositionValue.php +++ b/src/SteeringPositionValue.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A value indicating a steering position. * * @see http://schema.org/SteeringPositionValue * - * @mixin \Spatie\SchemaOrg\QualitativeValue */ -class SteeringPositionValue extends BaseType +class SteeringPositionValue extends BaseType implements QualitativeValueContract, EnumerationContract, IntangibleContract, ThingContract { /** * The steering position is on the left side of the vehicle (viewed from the @@ -27,4 +31,317 @@ class SteeringPositionValue extends BaseType */ const RightHandDriving = 'http://schema.org/RightHandDriving'; + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $equal + * + * @return static + * + * @see http://schema.org/equal + */ + public function equal($equal) + { + return $this->setProperty('equal', $equal); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is greater than the object. + * + * @param QualitativeValue|QualitativeValue[] $greater + * + * @return static + * + * @see http://schema.org/greater + */ + public function greater($greater) + { + return $this->setProperty('greater', $greater); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is greater than or equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $greaterOrEqual + * + * @return static + * + * @see http://schema.org/greaterOrEqual + */ + public function greaterOrEqual($greaterOrEqual) + { + return $this->setProperty('greaterOrEqual', $greaterOrEqual); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is lesser than the object. + * + * @param QualitativeValue|QualitativeValue[] $lesser + * + * @return static + * + * @see http://schema.org/lesser + */ + public function lesser($lesser) + { + return $this->setProperty('lesser', $lesser); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is lesser than or equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $lesserOrEqual + * + * @return static + * + * @see http://schema.org/lesserOrEqual + */ + public function lesserOrEqual($lesserOrEqual) + { + return $this->setProperty('lesserOrEqual', $lesserOrEqual); + } + + /** + * This ordering relation for qualitative values indicates that the subject + * is not equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $nonEqual + * + * @return static + * + * @see http://schema.org/nonEqual + */ + public function nonEqual($nonEqual) + { + return $this->setProperty('nonEqual', $nonEqual); + } + + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Store.php b/src/Store.php index 9b6361c04..8a179eeb4 100644 --- a/src/Store.php +++ b/src/Store.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A retail good store. * * @see http://schema.org/Store * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class Store extends BaseType +class Store extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/StructuredValue.php b/src/StructuredValue.php index 8296a20b0..3c7ec8964 100644 --- a/src/StructuredValue.php +++ b/src/StructuredValue.php @@ -2,14 +2,202 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Structured values are used when the value of a property has a more complex * structure than simply being a textual value or a reference to another thing. * * @see http://schema.org/StructuredValue * - * @mixin \Spatie\SchemaOrg\Intangible */ -class StructuredValue extends BaseType +class StructuredValue extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SubscribeAction.php b/src/SubscribeAction.php index 5a149365b..f621bd314 100644 --- a/src/SubscribeAction.php +++ b/src/SubscribeAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of forming a personal connection with someone/something (object) * unidirectionally/asymmetrically to get updates pushed to. @@ -18,8 +22,372 @@ * * @see http://schema.org/SubscribeAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class SubscribeAction extends BaseType +class SubscribeAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SubwayStation.php b/src/SubwayStation.php index d0328d500..41c841dba 100644 --- a/src/SubwayStation.php +++ b/src/SubwayStation.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A subway station. * * @see http://schema.org/SubwayStation * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class SubwayStation extends BaseType +class SubwayStation extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Suite.php b/src/Suite.php index ca1aa90da..2b5c1cda4 100644 --- a/src/Suite.php +++ b/src/Suite.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A suite in a hotel or other public accommodation, denotes a class of luxury * accommodations, the key feature of which is multiple rooms (Source: @@ -13,9 +17,8 @@ * * @see http://schema.org/Suite * - * @mixin \Spatie\SchemaOrg\Accommodation */ -class Suite extends BaseType +class Suite extends BaseType implements AccommodationContract, PlaceContract, ThingContract { /** * The type of bed or beds included in the accommodation. For the single @@ -70,4 +73,732 @@ public function occupancy($occupancy) return $this->setProperty('occupancy', $occupancy); } + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + + /** + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * + * @return static + * + * @see http://schema.org/numberOfRooms + */ + public function numberOfRooms($numberOfRooms) + { + return $this->setProperty('numberOfRooms', $numberOfRooms); + } + + /** + * Indications regarding the permitted usage of the accommodation. + * + * @param string|string[] $permittedUsage + * + * @return static + * + * @see http://schema.org/permittedUsage + */ + public function permittedUsage($permittedUsage) + { + return $this->setProperty('permittedUsage', $permittedUsage); + } + + /** + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. + * + * @param bool|bool[]|string|string[] $petsAllowed + * + * @return static + * + * @see http://schema.org/petsAllowed + */ + public function petsAllowed($petsAllowed) + { + return $this->setProperty('petsAllowed', $petsAllowed); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/SuspendAction.php b/src/SuspendAction.php index 18d1b1c70..ff910e5b2 100644 --- a/src/SuspendAction.php +++ b/src/SuspendAction.php @@ -2,14 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ControlActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of momentarily pausing a device or application (e.g. pause music * playback or pause a timer). * * @see http://schema.org/SuspendAction * - * @mixin \Spatie\SchemaOrg\ControlAction */ -class SuspendAction extends BaseType +class SuspendAction extends BaseType implements ControlActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Synagogue.php b/src/Synagogue.php index 939f4ca4b..1a18405f1 100644 --- a/src/Synagogue.php +++ b/src/Synagogue.php @@ -2,13 +2,712 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A synagogue. * * @see http://schema.org/Synagogue * - * @mixin \Spatie\SchemaOrg\PlaceOfWorship */ -class Synagogue extends BaseType +class Synagogue extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TVClip.php b/src/TVClip.php index c819f6d84..ae935efed 100644 --- a/src/TVClip.php +++ b/src/TVClip.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ClipContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A short TV program or a segment/part of a TV program. * * @see http://schema.org/TVClip * - * @mixin \Spatie\SchemaOrg\Clip */ -class TVClip extends BaseType +class TVClip extends BaseType implements ClipContract, CreativeWorkContract, ThingContract { /** * The TV series to which this episode or season belongs. @@ -25,4 +28,1641 @@ public function partOfTVSeries($partOfTVSeries) return $this->setProperty('partOfTVSeries', $partOfTVSeries); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TVEpisode.php b/src/TVEpisode.php index 736740380..2aef46b6f 100644 --- a/src/TVEpisode.php +++ b/src/TVEpisode.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EpisodeContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A TV episode which can be part of a series or season. * * @see http://schema.org/TVEpisode * - * @mixin \Spatie\SchemaOrg\Episode */ -class TVEpisode extends BaseType +class TVEpisode extends BaseType implements EpisodeContract, CreativeWorkContract, ThingContract { /** * The country of the principal offices of the production company or @@ -55,4 +58,1656 @@ public function subtitleLanguage($subtitleLanguage) return $this->setProperty('subtitleLanguage', $subtitleLanguage); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * Position of the episode within an ordered group of episodes. + * + * @param int|int[]|string|string[] $episodeNumber + * + * @return static + * + * @see http://schema.org/episodeNumber + */ + public function episodeNumber($episodeNumber) + { + return $this->setProperty('episodeNumber', $episodeNumber); + } + + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TVSeason.php b/src/TVSeason.php index 77a842501..d137c2489 100644 --- a/src/TVSeason.php +++ b/src/TVSeason.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeasonContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Season dedicated to TV broadcast and associated online delivery. * * @see http://schema.org/TVSeason * - * @mixin \Spatie\SchemaOrg\CreativeWork - * @mixin \Spatie\SchemaOrg\CreativeWorkSeason */ -class TVSeason extends BaseType +class TVSeason extends BaseType implements CreativeWorkContract, CreativeWorkSeasonContract, CreativeWorkContract, ThingContract { /** * The country of the principal offices of the production company or @@ -41,4 +44,1670 @@ public function partOfTVSeries($partOfTVSeries) return $this->setProperty('partOfTVSeries', $partOfTVSeries); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An episode of a tv, radio or game media within a series or season. + * + * @param Episode|Episode[] $episode + * + * @return static + * + * @see http://schema.org/episode + */ + public function episode($episode) + { + return $this->setProperty('episode', $episode); + } + + /** + * An episode of a TV/radio series or season. + * + * @param Episode|Episode[] $episodes + * + * @return static + * + * @see http://schema.org/episodes + */ + public function episodes($episodes) + { + return $this->setProperty('episodes', $episodes); + } + + /** + * The number of episodes in this season or series. + * + * @param int|int[] $numberOfEpisodes + * + * @return static + * + * @see http://schema.org/numberOfEpisodes + */ + public function numberOfEpisodes($numberOfEpisodes) + { + return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * Position of the season within an ordered group of seasons. + * + * @param int|int[]|string|string[] $seasonNumber + * + * @return static + * + * @see http://schema.org/seasonNumber + */ + public function seasonNumber($seasonNumber) + { + return $this->setProperty('seasonNumber', $seasonNumber); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + } diff --git a/src/TVSeries.php b/src/TVSeries.php index ea9d29f02..efc5da4cc 100644 --- a/src/TVSeries.php +++ b/src/TVSeries.php @@ -2,15 +2,20 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * CreativeWorkSeries dedicated to TV broadcast and associated online delivery. * * @see http://schema.org/TVSeries * - * @mixin \Spatie\SchemaOrg\CreativeWork - * @mixin \Spatie\SchemaOrg\CreativeWorkSeries */ -class TVSeries extends BaseType +class TVSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -230,4 +235,1571 @@ public function trailer($trailer) return $this->setProperty('trailer', $trailer); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + } diff --git a/src/Table.php b/src/Table.php index 84f1db38f..c98d99654 100644 --- a/src/Table.php +++ b/src/Table.php @@ -2,13 +2,1521 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A table on a Web page. * * @see http://schema.org/Table * - * @mixin \Spatie\SchemaOrg\WebPageElement */ -class Table extends BaseType +class Table extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TakeAction.php b/src/TakeAction.php index 7737ac23c..ab85efe73 100644 --- a/src/TakeAction.php +++ b/src/TakeAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of gaining ownership of an object from an origin. Reciprocal of * GiveAction. @@ -14,8 +18,402 @@ * * @see http://schema.org/TakeAction * - * @mixin \Spatie\SchemaOrg\TransferAction */ -class TakeAction extends BaseType +class TakeAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TattooParlor.php b/src/TattooParlor.php index 959bec206..7d8a558ef 100644 --- a/src/TattooParlor.php +++ b/src/TattooParlor.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\HealthAndBeautyBusinessContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A tattoo parlor. * * @see http://schema.org/TattooParlor * - * @mixin \Spatie\SchemaOrg\HealthAndBeautyBusiness */ -class TattooParlor extends BaseType +class TattooParlor extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Taxi.php b/src/Taxi.php index 848bf73de..a46e47846 100644 --- a/src/Taxi.php +++ b/src/Taxi.php @@ -2,13 +2,540 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A taxi. * * @see http://schema.org/Taxi * - * @mixin \Spatie\SchemaOrg\Service */ -class Taxi extends BaseType +class Taxi extends BaseType implements ServiceContract, IntangibleContract, ThingContract { + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TaxiReservation.php b/src/TaxiReservation.php index 58bea4a03..7e79324b8 100644 --- a/src/TaxiReservation.php +++ b/src/TaxiReservation.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservation for a taxi. * @@ -11,9 +15,8 @@ * * @see http://schema.org/TaxiReservation * - * @mixin \Spatie\SchemaOrg\Reservation */ -class TaxiReservation extends BaseType +class TaxiReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** * Number of people the reservation should accommodate. @@ -57,4 +60,396 @@ public function pickupTime($pickupTime) return $this->setProperty('pickupTime', $pickupTime); } + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TaxiService.php b/src/TaxiService.php index 65ad613bf..70ea6e7bd 100644 --- a/src/TaxiService.php +++ b/src/TaxiService.php @@ -2,14 +2,541 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ServiceContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A service for a vehicle for hire with a driver for local travel. Fares are * usually calculated based on distance traveled. * * @see http://schema.org/TaxiService * - * @mixin \Spatie\SchemaOrg\Service */ -class TaxiService extends BaseType +class TaxiService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). + * + * @param ServiceChannel|ServiceChannel[] $availableChannel + * + * @return static + * + * @see http://schema.org/availableChannel + */ + public function availableChannel($availableChannel) + { + return $this->setProperty('availableChannel', $availableChannel); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * The hours during which this service or contact is available. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * + * @return static + * + * @see http://schema.org/hoursAvailable + */ + public function hoursAvailable($hoursAvailable) + { + return $this->setProperty('hoursAvailable', $hoursAvailable); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $produces + * + * @return static + * + * @see http://schema.org/produces + */ + public function produces($produces) + { + return $this->setProperty('produces', $produces); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * + * @param string|string[] $providerMobility + * + * @return static + * + * @see http://schema.org/providerMobility + */ + public function providerMobility($providerMobility) + { + return $this->setProperty('providerMobility', $providerMobility); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * The audience eligible for this service. + * + * @param Audience|Audience[] $serviceAudience + * + * @return static + * + * @see http://schema.org/serviceAudience + */ + public function serviceAudience($serviceAudience) + { + return $this->setProperty('serviceAudience', $serviceAudience); + } + + /** + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. + * + * @param Thing|Thing[] $serviceOutput + * + * @return static + * + * @see http://schema.org/serviceOutput + */ + public function serviceOutput($serviceOutput) + { + return $this->setProperty('serviceOutput', $serviceOutput); + } + + /** + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. + * + * @param string|string[] $serviceType + * + * @return static + * + * @see http://schema.org/serviceType + */ + public function serviceType($serviceType) + { + return $this->setProperty('serviceType', $serviceType); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TaxiStand.php b/src/TaxiStand.php index 3253f76e4..f1a2f822c 100644 --- a/src/TaxiStand.php +++ b/src/TaxiStand.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A taxi stand. * * @see http://schema.org/TaxiStand * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class TaxiStand extends BaseType +class TaxiStand extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TechArticle.php b/src/TechArticle.php index 7286c9294..e29dace50 100644 --- a/src/TechArticle.php +++ b/src/TechArticle.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A technical article - Example: How-to (task) topics, step-by-step, procedural * troubleshooting, specifications, etc. * * @see http://schema.org/TechArticle * - * @mixin \Spatie\SchemaOrg\Article */ -class TechArticle extends BaseType +class TechArticle extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { /** * Prerequisites needed to fulfill steps in article. @@ -41,4 +44,1634 @@ public function proficiencyLevel($proficiencyLevel) return $this->setProperty('proficiencyLevel', $proficiencyLevel); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * The number of words in the text of the Article. + * + * @param int|int[] $wordCount + * + * @return static + * + * @see http://schema.org/wordCount + */ + public function wordCount($wordCount) + { + return $this->setProperty('wordCount', $wordCount); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TelevisionChannel.php b/src/TelevisionChannel.php index 45b9967db..6abb0c1df 100644 --- a/src/TelevisionChannel.php +++ b/src/TelevisionChannel.php @@ -2,14 +2,291 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BroadcastChannelContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A unique instance of a television BroadcastService on a * CableOrSatelliteService lineup. * * @see http://schema.org/TelevisionChannel * - * @mixin \Spatie\SchemaOrg\BroadcastChannel */ -class TelevisionChannel extends BaseType +class TelevisionChannel extends BaseType implements BroadcastChannelContract, IntangibleContract, ThingContract { + /** + * The unique address by which the BroadcastService can be identified in a + * provider lineup. In US, this is typically a number. + * + * @param string|string[] $broadcastChannelId + * + * @return static + * + * @see http://schema.org/broadcastChannelId + */ + public function broadcastChannelId($broadcastChannelId) + { + return $this->setProperty('broadcastChannelId', $broadcastChannelId); + } + + /** + * The frequency used for over-the-air broadcasts. Numeric values or simple + * ranges e.g. 87-99. In addition a shortcut idiom is supported for + * frequences of AM and FM radio channels, e.g. "87 FM". + * + * @param BroadcastFrequencySpecification|BroadcastFrequencySpecification[]|string|string[] $broadcastFrequency + * + * @return static + * + * @see http://schema.org/broadcastFrequency + */ + public function broadcastFrequency($broadcastFrequency) + { + return $this->setProperty('broadcastFrequency', $broadcastFrequency); + } + + /** + * The type of service required to have access to the channel (e.g. Standard + * or Premium). + * + * @param string|string[] $broadcastServiceTier + * + * @return static + * + * @see http://schema.org/broadcastServiceTier + */ + public function broadcastServiceTier($broadcastServiceTier) + { + return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TelevisionStation.php b/src/TelevisionStation.php index 186b46f2e..c4fb1206a 100644 --- a/src/TelevisionStation.php +++ b/src/TelevisionStation.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A television station. * * @see http://schema.org/TelevisionStation * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class TelevisionStation extends BaseType +class TelevisionStation extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/TennisComplex.php b/src/TennisComplex.php index e9622d678..64996943e 100644 --- a/src/TennisComplex.php +++ b/src/TennisComplex.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A tennis complex. * * @see http://schema.org/TennisComplex * - * @mixin \Spatie\SchemaOrg\SportsActivityLocation */ -class TennisComplex extends BaseType +class TennisComplex extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/TextDigitalDocument.php b/src/TextDigitalDocument.php index bd123125e..bd4371bc9 100644 --- a/src/TextDigitalDocument.php +++ b/src/TextDigitalDocument.php @@ -2,13 +2,1537 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A file composed primarily of text. * * @see http://schema.org/TextDigitalDocument * - * @mixin \Spatie\SchemaOrg\DigitalDocument */ -class TextDigitalDocument extends BaseType +class TextDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract { + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TheaterEvent.php b/src/TheaterEvent.php index 5d81d855b..224fb6929 100644 --- a/src/TheaterEvent.php +++ b/src/TheaterEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Theater performance. * * @see http://schema.org/TheaterEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class TheaterEvent extends BaseType +class TheaterEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TheaterGroup.php b/src/TheaterGroup.php index b73b8a932..5b50e5bb9 100644 --- a/src/TheaterGroup.php +++ b/src/TheaterGroup.php @@ -2,14 +2,939 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A theater group or company, for example, the Royal Shakespeare Company or * Druid Theatre. * * @see http://schema.org/TheaterGroup * - * @mixin \Spatie\SchemaOrg\PerformingGroup */ -class TheaterGroup extends BaseType +class TheaterGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Thing.php b/src/Thing.php index c58214d4f..c43f828a3 100644 --- a/src/Thing.php +++ b/src/Thing.php @@ -2,10 +2,12 @@ namespace Spatie\SchemaOrg; + /** * The most generic type of item. * * @see http://schema.org/Thing + * */ class Thing extends BaseType { @@ -168,7 +170,7 @@ public function sameAs($sameAs) } /** - * A CreativeWork or Event about this Thing.. + * A CreativeWork or Event about this Thing. * * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * diff --git a/src/Ticket.php b/src/Ticket.php index b0a1312dd..73cbd9f32 100644 --- a/src/Ticket.php +++ b/src/Ticket.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Used to describe a ticket to an event, a flight, a bus ride, etc. * * @see http://schema.org/Ticket * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Ticket extends BaseType +class Ticket extends BaseType implements IntangibleContract, ThingContract { /** * The date the ticket was issued. @@ -141,4 +143,190 @@ public function underName($underName) return $this->setProperty('underName', $underName); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TieAction.php b/src/TieAction.php index 81bf8e5ac..1de0a1ff3 100644 --- a/src/TieAction.php +++ b/src/TieAction.php @@ -2,13 +2,381 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AchieveActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of reaching a draw in a competitive activity. * * @see http://schema.org/TieAction * - * @mixin \Spatie\SchemaOrg\AchieveAction */ -class TieAction extends BaseType +class TieAction extends BaseType implements AchieveActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TipAction.php b/src/TipAction.php index 9847a9b94..f1e205f3a 100644 --- a/src/TipAction.php +++ b/src/TipAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of giving money voluntarily to a beneficiary in recognition of * services rendered. * * @see http://schema.org/TipAction * - * @mixin \Spatie\SchemaOrg\TradeAction */ -class TipAction extends BaseType +class TipAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** * A sub property of participant. The participant who is at the receiving @@ -27,4 +30,444 @@ public function recipient($recipient) return $this->setProperty('recipient', $recipient); } + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. + * + * @param PriceSpecification|PriceSpecification[] $priceSpecification + * + * @return static + * + * @see http://schema.org/priceSpecification + */ + public function priceSpecification($priceSpecification) + { + return $this->setProperty('priceSpecification', $priceSpecification); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TireShop.php b/src/TireShop.php index e06c65ed4..fc40cabe2 100644 --- a/src/TireShop.php +++ b/src/TireShop.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A tire shop. * * @see http://schema.org/TireShop * - * @mixin \Spatie\SchemaOrg\Store */ -class TireShop extends BaseType +class TireShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/TouristAttraction.php b/src/TouristAttraction.php index f52254834..dc082cffe 100644 --- a/src/TouristAttraction.php +++ b/src/TouristAttraction.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A tourist attraction. In principle any Thing can be a [[TouristAttraction]], * from a [[Mountain]] and [[LandmarksOrHistoricalBuildings]] to a @@ -11,9 +14,8 @@ * * @see http://schema.org/TouristAttraction * - * @mixin \Spatie\SchemaOrg\Place */ -class TouristAttraction extends BaseType +class TouristAttraction extends BaseType implements PlaceContract, ThingContract { /** * A language someone may use with or at the item, service or place. Please @@ -46,4 +48,670 @@ public function touristType($touristType) return $this->setProperty('touristType', $touristType); } + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TouristInformationCenter.php b/src/TouristInformationCenter.php index 94ddb1ff9..f6c66e58f 100644 --- a/src/TouristInformationCenter.php +++ b/src/TouristInformationCenter.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A tourist information center. * * @see http://schema.org/TouristInformationCenter * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class TouristInformationCenter extends BaseType +class TouristInformationCenter extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/ToyStore.php b/src/ToyStore.php index 3b470eb3b..79e50ed6c 100644 --- a/src/ToyStore.php +++ b/src/ToyStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A toy store. * * @see http://schema.org/ToyStore * - * @mixin \Spatie\SchemaOrg\Store */ -class ToyStore extends BaseType +class ToyStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/TrackAction.php b/src/TrackAction.php index d67928824..0787f1900 100644 --- a/src/TrackAction.php +++ b/src/TrackAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FindActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An agent tracks an object for updates. * @@ -14,9 +18,8 @@ * * @see http://schema.org/TrackAction * - * @mixin \Spatie\SchemaOrg\FindAction */ -class TrackAction extends BaseType +class TrackAction extends BaseType implements FindActionContract, ActionContract, ThingContract { /** * A sub property of instrument. The method of delivery. @@ -32,4 +35,369 @@ public function deliveryMethod($deliveryMethod) return $this->setProperty('deliveryMethod', $deliveryMethod); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TradeAction.php b/src/TradeAction.php index e928b65b1..1b4f119e9 100644 --- a/src/TradeAction.php +++ b/src/TradeAction.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of participating in an exchange of goods and services for monetary * compensation. An agent trades an object, product or service with a @@ -9,9 +12,8 @@ * * @see http://schema.org/TradeAction * - * @mixin \Spatie\SchemaOrg\Action */ -class TradeAction extends BaseType +class TradeAction extends BaseType implements ActionContract, ThingContract { /** * The offer price of a product, or of a price component when attached to @@ -88,4 +90,369 @@ public function priceSpecification($priceSpecification) return $this->setProperty('priceSpecification', $priceSpecification); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TrainReservation.php b/src/TrainReservation.php index e2e7b6ff2..51a42d009 100644 --- a/src/TrainReservation.php +++ b/src/TrainReservation.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReservationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A reservation for train travel. * @@ -11,8 +15,399 @@ * * @see http://schema.org/TrainReservation * - * @mixin \Spatie\SchemaOrg\Reservation */ -class TrainReservation extends BaseType +class TrainReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { + /** + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. + * + * @param Organization|Organization[]|Person|Person[] $bookingAgent + * + * @return static + * + * @see http://schema.org/bookingAgent + */ + public function bookingAgent($bookingAgent) + { + return $this->setProperty('bookingAgent', $bookingAgent); + } + + /** + * The date and time the reservation was booked. + * + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * + * @return static + * + * @see http://schema.org/bookingTime + */ + public function bookingTime($bookingTime) + { + return $this->setProperty('bookingTime', $bookingTime); + } + + /** + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. + * + * @param Organization|Organization[]|Person|Person[] $broker + * + * @return static + * + * @see http://schema.org/broker + */ + public function broker($broker) + { + return $this->setProperty('broker', $broker); + } + + /** + * The date and time the reservation was modified. + * + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * + * @return static + * + * @see http://schema.org/modifiedTime + */ + public function modifiedTime($modifiedTime) + { + return $this->setProperty('modifiedTime', $modifiedTime); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. + * + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * + * @return static + * + * @see http://schema.org/programMembershipUsed + */ + public function programMembershipUsed($programMembershipUsed) + { + return $this->setProperty('programMembershipUsed', $programMembershipUsed); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * The thing -- flight, event, restaurant,etc. being reserved. + * + * @param Thing|Thing[] $reservationFor + * + * @return static + * + * @see http://schema.org/reservationFor + */ + public function reservationFor($reservationFor) + { + return $this->setProperty('reservationFor', $reservationFor); + } + + /** + * A unique identifier for the reservation. + * + * @param string|string[] $reservationId + * + * @return static + * + * @see http://schema.org/reservationId + */ + public function reservationId($reservationId) + { + return $this->setProperty('reservationId', $reservationId); + } + + /** + * The current status of the reservation. + * + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * + * @return static + * + * @see http://schema.org/reservationStatus + */ + public function reservationStatus($reservationStatus) + { + return $this->setProperty('reservationStatus', $reservationStatus); + } + + /** + * A ticket associated with the reservation. + * + * @param Ticket|Ticket[] $reservedTicket + * + * @return static + * + * @see http://schema.org/reservedTicket + */ + public function reservedTicket($reservedTicket) + { + return $this->setProperty('reservedTicket', $reservedTicket); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TrainStation.php b/src/TrainStation.php index f25fc0963..5d8041b90 100644 --- a/src/TrainStation.php +++ b/src/TrainStation.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A train station. * * @see http://schema.org/TrainStation * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class TrainStation extends BaseType +class TrainStation extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TrainTrip.php b/src/TrainTrip.php index c1e592e34..83397f9b1 100644 --- a/src/TrainTrip.php +++ b/src/TrainTrip.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\TripContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A trip on a commercial train line. * * @see http://schema.org/TrainTrip * - * @mixin \Spatie\SchemaOrg\Trip */ -class TrainTrip extends BaseType +class TrainTrip extends BaseType implements TripContract, IntangibleContract, ThingContract { /** * The platform where the train arrives. @@ -95,4 +98,250 @@ public function trainNumber($trainNumber) return $this->setProperty('trainNumber', $trainNumber); } + /** + * The expected arrival time. + * + * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime + * + * @return static + * + * @see http://schema.org/arrivalTime + */ + public function arrivalTime($arrivalTime) + { + return $this->setProperty('arrivalTime', $arrivalTime); + } + + /** + * The expected departure time. + * + * @param \DateTimeInterface|\DateTimeInterface[] $departureTime + * + * @return static + * + * @see http://schema.org/departureTime + */ + public function departureTime($departureTime) + { + return $this->setProperty('departureTime', $departureTime); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TransferAction.php b/src/TransferAction.php index 156dac9ab..88e9faa17 100644 --- a/src/TransferAction.php +++ b/src/TransferAction.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of transferring/moving (abstract or concrete) animate or inanimate * objects from one place to another. * * @see http://schema.org/TransferAction * - * @mixin \Spatie\SchemaOrg\Action */ -class TransferAction extends BaseType +class TransferAction extends BaseType implements ActionContract, ThingContract { /** * A sub property of location. The original location of the object or the @@ -42,4 +44,369 @@ public function toLocation($toLocation) return $this->setProperty('toLocation', $toLocation); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TravelAction.php b/src/TravelAction.php index 52e65cbdf..cefa80fba 100644 --- a/src/TravelAction.php +++ b/src/TravelAction.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MoveActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of traveling from an fromLocation to a destination by a specified * mode of transport, optionally with participants. * * @see http://schema.org/TravelAction * - * @mixin \Spatie\SchemaOrg\MoveAction */ -class TravelAction extends BaseType +class TravelAction extends BaseType implements MoveActionContract, ActionContract, ThingContract { /** * The distance travelled, e.g. exercising or travelling. @@ -26,4 +29,399 @@ public function distance($distance) return $this->setProperty('distance', $distance); } + /** + * A sub property of location. The original location of the object or the + * agent before the action. + * + * @param Place|Place[] $fromLocation + * + * @return static + * + * @see http://schema.org/fromLocation + */ + public function fromLocation($fromLocation) + { + return $this->setProperty('fromLocation', $fromLocation); + } + + /** + * A sub property of location. The final location of the object or the agent + * after the action. + * + * @param Place|Place[] $toLocation + * + * @return static + * + * @see http://schema.org/toLocation + */ + public function toLocation($toLocation) + { + return $this->setProperty('toLocation', $toLocation); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TravelAgency.php b/src/TravelAgency.php index 49599091a..2175f78f8 100644 --- a/src/TravelAgency.php +++ b/src/TravelAgency.php @@ -2,13 +2,1338 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A travel agency. * * @see http://schema.org/TravelAgency * - * @mixin \Spatie\SchemaOrg\LocalBusiness */ -class TravelAgency extends BaseType +class TravelAgency extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/Trip.php b/src/Trip.php index 56ac533e6..1abc14b7d 100644 --- a/src/Trip.php +++ b/src/Trip.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A trip or journey. An itinerary of visits to one or more places. * * @see http://schema.org/Trip * - * @mixin \Spatie\SchemaOrg\Intangible */ -class Trip extends BaseType +class Trip extends BaseType implements IntangibleContract, ThingContract { /** * The expected arrival time. @@ -71,4 +73,190 @@ public function provider($provider) return $this->setProperty('provider', $provider); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/TypeAndQuantityNode.php b/src/TypeAndQuantityNode.php index fc54cb846..1d2acfc24 100644 --- a/src/TypeAndQuantityNode.php +++ b/src/TypeAndQuantityNode.php @@ -2,15 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A structured value indicating the quantity, unit of measurement, and business * function of goods included in a bundle offer. * * @see http://schema.org/TypeAndQuantityNode * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class TypeAndQuantityNode extends BaseType +class TypeAndQuantityNode extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The quantity of the goods included in the offer. @@ -88,4 +91,190 @@ public function unitText($unitText) return $this->setProperty('unitText', $unitText); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UnRegisterAction.php b/src/UnRegisterAction.php index 7fed33b43..cb9a77f78 100644 --- a/src/UnRegisterAction.php +++ b/src/UnRegisterAction.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of un-registering from a service. * @@ -14,8 +18,372 @@ * * @see http://schema.org/UnRegisterAction * - * @mixin \Spatie\SchemaOrg\InteractAction */ -class UnRegisterAction extends BaseType +class UnRegisterAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UnitPriceSpecification.php b/src/UnitPriceSpecification.php index 025de4272..9a6f9aba7 100644 --- a/src/UnitPriceSpecification.php +++ b/src/UnitPriceSpecification.php @@ -2,14 +2,18 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\PriceSpecificationContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The price asked for a given offer by the respective organization or person. * * @see http://schema.org/UnitPriceSpecification * - * @mixin \Spatie\SchemaOrg\PriceSpecification */ -class UnitPriceSpecification extends BaseType +class UnitPriceSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract { /** * This property specifies the minimal quantity and rounding increment that @@ -92,4 +96,355 @@ public function unitText($unitText) return $this->setProperty('unitText', $unitText); } + /** + * The interval and unit of measurement of ordering quantities for which the + * offer or price specification is valid. This allows e.g. specifying that a + * certain freight charge is valid only for a certain quantity. + * + * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity + * + * @return static + * + * @see http://schema.org/eligibleQuantity + */ + public function eligibleQuantity($eligibleQuantity) + { + return $this->setProperty('eligibleQuantity', $eligibleQuantity); + } + + /** + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. + * + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * + * @return static + * + * @see http://schema.org/eligibleTransactionVolume + */ + public function eligibleTransactionVolume($eligibleTransactionVolume) + { + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + } + + /** + * The highest price if the price is a range. + * + * @param float|float[]|int|int[] $maxPrice + * + * @return static + * + * @see http://schema.org/maxPrice + */ + public function maxPrice($maxPrice) + { + return $this->setProperty('maxPrice', $maxPrice); + } + + /** + * The lowest price if the price is a range. + * + * @param float|float[]|int|int[] $minPrice + * + * @return static + * + * @see http://schema.org/minPrice + */ + public function minPrice($minPrice) + { + return $this->setProperty('minPrice', $minPrice); + } + + /** + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * + * @param float|float[]|int|int[]|string|string[] $price + * + * @return static + * + * @see http://schema.org/price + */ + public function price($price) + { + return $this->setProperty('price', $price); + } + + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * + * @return static + * + * @see http://schema.org/validThrough + */ + public function validThrough($validThrough) + { + return $this->setProperty('validThrough', $validThrough); + } + + /** + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. + * + * @param bool|bool[] $valueAddedTaxIncluded + * + * @return static + * + * @see http://schema.org/valueAddedTaxIncluded + */ + public function valueAddedTaxIncluded($valueAddedTaxIncluded) + { + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UpdateAction.php b/src/UpdateAction.php index 1498a9b9f..1041fcbd9 100644 --- a/src/UpdateAction.php +++ b/src/UpdateAction.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of managing by changing/editing the state of the object. * * @see http://schema.org/UpdateAction * - * @mixin \Spatie\SchemaOrg\Action */ -class UpdateAction extends BaseType +class UpdateAction extends BaseType implements ActionContract, ThingContract { /** * A sub property of object. The collection target of the action. @@ -39,4 +41,369 @@ public function targetCollection($targetCollection) return $this->setProperty('targetCollection', $targetCollection); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UseAction.php b/src/UseAction.php index f3714d3bf..f5427079e 100644 --- a/src/UseAction.php +++ b/src/UseAction.php @@ -2,13 +2,413 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of applying an object to its intended purpose. * * @see http://schema.org/UseAction * - * @mixin \Spatie\SchemaOrg\ConsumeAction */ -class UseAction extends BaseType +class UseAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserBlocks.php b/src/UserBlocks.php index 632c46504..3bbc79c2c 100644 --- a/src/UserBlocks.php +++ b/src/UserBlocks.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +13,718 @@ * * @see http://schema.org/UserBlocks * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserBlocks extends BaseType +class UserBlocks extends BaseType implements UserInteractionContract, EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserCheckins.php b/src/UserCheckins.php index 1bbb69570..a225209f9 100644 --- a/src/UserCheckins.php +++ b/src/UserCheckins.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +13,718 @@ * * @see http://schema.org/UserCheckins * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserCheckins extends BaseType +class UserCheckins extends BaseType implements UserInteractionContract, EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserComments.php b/src/UserComments.php index 6f2c65b79..b2f72f1b0 100644 --- a/src/UserComments.php +++ b/src/UserComments.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,9 +13,8 @@ * * @see http://schema.org/UserComments * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserComments extends BaseType +class UserComments extends BaseType implements UserInteractionContract, EventContract, ThingContract { /** * The text of the UserComment. @@ -84,4 +87,715 @@ public function replyToUrl($replyToUrl) return $this->setProperty('replyToUrl', $replyToUrl); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserDownloads.php b/src/UserDownloads.php index c0b46d8aa..2c62407fe 100644 --- a/src/UserDownloads.php +++ b/src/UserDownloads.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +13,718 @@ * * @see http://schema.org/UserDownloads * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserDownloads extends BaseType +class UserDownloads extends BaseType implements UserInteractionContract, EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserInteraction.php b/src/UserInteraction.php index ad4681e8b..ab3a66bef 100644 --- a/src/UserInteraction.php +++ b/src/UserInteraction.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +12,718 @@ * * @see http://schema.org/UserInteraction * - * @mixin \Spatie\SchemaOrg\Event */ -class UserInteraction extends BaseType +class UserInteraction extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserLikes.php b/src/UserLikes.php index d1c0488b4..c85a07bb9 100644 --- a/src/UserLikes.php +++ b/src/UserLikes.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +13,718 @@ * * @see http://schema.org/UserLikes * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserLikes extends BaseType +class UserLikes extends BaseType implements UserInteractionContract, EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserPageVisits.php b/src/UserPageVisits.php index 0e9d648d9..cdd5e3819 100644 --- a/src/UserPageVisits.php +++ b/src/UserPageVisits.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +13,718 @@ * * @see http://schema.org/UserPageVisits * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserPageVisits extends BaseType +class UserPageVisits extends BaseType implements UserInteractionContract, EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserPlays.php b/src/UserPlays.php index ee0ceaebc..06c7125bb 100644 --- a/src/UserPlays.php +++ b/src/UserPlays.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +13,718 @@ * * @see http://schema.org/UserPlays * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserPlays extends BaseType +class UserPlays extends BaseType implements UserInteractionContract, EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserPlusOnes.php b/src/UserPlusOnes.php index 36200fd8d..5c0b4800b 100644 --- a/src/UserPlusOnes.php +++ b/src/UserPlusOnes.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +13,718 @@ * * @see http://schema.org/UserPlusOnes * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserPlusOnes extends BaseType +class UserPlusOnes extends BaseType implements UserInteractionContract, EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/UserTweets.php b/src/UserTweets.php index 2a5e46efa..2d46b7320 100644 --- a/src/UserTweets.php +++ b/src/UserTweets.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * UserInteraction and its subtypes is an old way of talking about users * interacting with pages. It is generally better to use [[Action]]-based @@ -9,8 +13,718 @@ * * @see http://schema.org/UserTweets * - * @mixin \Spatie\SchemaOrg\UserInteraction */ -class UserTweets extends BaseType +class UserTweets extends BaseType implements UserInteractionContract, EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Vehicle.php b/src/Vehicle.php index aec9c56cb..04237dfb7 100644 --- a/src/Vehicle.php +++ b/src/Vehicle.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ProductContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A vehicle is a device that is designed or used to transport people or cargo * over land, water, air, or through space. * * @see http://schema.org/Vehicle * - * @mixin \Spatie\SchemaOrg\Product */ -class Vehicle extends BaseType +class Vehicle extends BaseType implements ProductContract, ThingContract { /** * The available volume for cargo or luggage. For automobiles, this is @@ -421,4 +423,724 @@ public function vehicleTransmission($vehicleTransmission) return $this->setProperty('vehicleTransmission', $vehicleTransmission); } + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. + * + * @param Thing|Thing[]|string|string[] $category + * + * @return static + * + * @see http://schema.org/category + */ + public function category($category) + { + return $this->setProperty('category', $category); + } + + /** + * The color of the product. + * + * @param string|string[] $color + * + * @return static + * + * @see http://schema.org/color + */ + public function color($color) + { + return $this->setProperty('color', $color); + } + + /** + * The depth of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth + * + * @return static + * + * @see http://schema.org/depth + */ + public function depth($depth) + { + return $this->setProperty('depth', $depth); + } + + /** + * The GTIN-12 code of the product, or the product to which the offer + * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a + * U.P.C. Company Prefix, Item Reference, and Check Digit used to identify + * trade items. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin12 + * + * @return static + * + * @see http://schema.org/gtin12 + */ + public function gtin12($gtin12) + { + return $this->setProperty('gtin12', $gtin12); + } + + /** + * The GTIN-13 code of the product, or the product to which the offer + * refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former + * 12-digit UPC codes can be converted into a GTIN-13 code by simply adding + * a preceeding zero. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin13 + * + * @return static + * + * @see http://schema.org/gtin13 + */ + public function gtin13($gtin13) + { + return $this->setProperty('gtin13', $gtin13); + } + + /** + * The GTIN-14 code of the product, or the product to which the offer + * refers. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin14 + * + * @return static + * + * @see http://schema.org/gtin14 + */ + public function gtin14($gtin14) + { + return $this->setProperty('gtin14', $gtin14); + } + + /** + * The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of + * the product, or the product to which the offer refers. This code is also + * known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN + * Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more + * details. + * + * @param string|string[] $gtin8 + * + * @return static + * + * @see http://schema.org/gtin8 + */ + public function gtin8($gtin8) + { + return $this->setProperty('gtin8', $gtin8); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is an accessory or spare part. + * + * @param Product|Product[] $isAccessoryOrSparePartFor + * + * @return static + * + * @see http://schema.org/isAccessoryOrSparePartFor + */ + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor) + { + return $this->setProperty('isAccessoryOrSparePartFor', $isAccessoryOrSparePartFor); + } + + /** + * A pointer to another product (or multiple products) for which this + * product is a consumable. + * + * @param Product|Product[] $isConsumableFor + * + * @return static + * + * @see http://schema.org/isConsumableFor + */ + public function isConsumableFor($isConsumableFor) + { + return $this->setProperty('isConsumableFor', $isConsumableFor); + } + + /** + * A pointer to another, somehow related product (or multiple products). + * + * @param Product|Product[]|Service|Service[] $isRelatedTo + * + * @return static + * + * @see http://schema.org/isRelatedTo + */ + public function isRelatedTo($isRelatedTo) + { + return $this->setProperty('isRelatedTo', $isRelatedTo); + } + + /** + * A pointer to another, functionally similar product (or multiple + * products). + * + * @param Product|Product[]|Service|Service[] $isSimilarTo + * + * @return static + * + * @see http://schema.org/isSimilarTo + */ + public function isSimilarTo($isSimilarTo) + { + return $this->setProperty('isSimilarTo', $isSimilarTo); + } + + /** + * A predefined value from OfferItemCondition or a textual description of + * the condition of the product or service, or the products or services + * included in the offer. + * + * @param OfferItemCondition|OfferItemCondition[] $itemCondition + * + * @return static + * + * @see http://schema.org/itemCondition + */ + public function itemCondition($itemCondition) + { + return $this->setProperty('itemCondition', $itemCondition); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The manufacturer of the product. + * + * @param Organization|Organization[] $manufacturer + * + * @return static + * + * @see http://schema.org/manufacturer + */ + public function manufacturer($manufacturer) + { + return $this->setProperty('manufacturer', $manufacturer); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * The model of the product. Use with the URL of a ProductModel or a textual + * representation of the model identifier. The URL of the ProductModel can + * be from an external source. It is recommended to additionally provide + * strong product identifiers via the gtin8/gtin13/gtin14 and mpn + * properties. + * + * @param ProductModel|ProductModel[]|string|string[] $model + * + * @return static + * + * @see http://schema.org/model + */ + public function model($model) + { + return $this->setProperty('model', $model); + } + + /** + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. + * + * @param string|string[] $mpn + * + * @return static + * + * @see http://schema.org/mpn + */ + public function mpn($mpn) + { + return $this->setProperty('mpn', $mpn); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The product identifier, such as ISBN. For example: ``` meta + * itemprop="productID" content="isbn:123-456-789" ```. + * + * @param string|string[] $productID + * + * @return static + * + * @see http://schema.org/productID + */ + public function productID($productID) + { + return $this->setProperty('productID', $productID); + } + + /** + * The date of production of the item, e.g. vehicle. + * + * @param \DateTimeInterface|\DateTimeInterface[] $productionDate + * + * @return static + * + * @see http://schema.org/productionDate + */ + public function productionDate($productionDate) + { + return $this->setProperty('productionDate', $productionDate); + } + + /** + * The date the item e.g. vehicle was purchased by the current owner. + * + * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate + * + * @return static + * + * @see http://schema.org/purchaseDate + */ + public function purchaseDate($purchaseDate) + { + return $this->setProperty('purchaseDate', $purchaseDate); + } + + /** + * The release date of a product or product model. This can be used to + * distinguish the exact variant of a product. + * + * @param \DateTimeInterface|\DateTimeInterface[] $releaseDate + * + * @return static + * + * @see http://schema.org/releaseDate + */ + public function releaseDate($releaseDate) + { + return $this->setProperty('releaseDate', $releaseDate); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a + * product or service, or the product to which the offer refers. + * + * @param string|string[] $sku + * + * @return static + * + * @see http://schema.org/sku + */ + public function sku($sku) + { + return $this->setProperty('sku', $sku); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * The weight of the product or person. + * + * @param QuantitativeValue|QuantitativeValue[] $weight + * + * @return static + * + * @see http://schema.org/weight + */ + public function weight($weight) + { + return $this->setProperty('weight', $weight); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/VideoGallery.php b/src/VideoGallery.php index d7e37f224..ae55514a2 100644 --- a/src/VideoGallery.php +++ b/src/VideoGallery.php @@ -2,13 +2,1692 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CollectionPageContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web page type: Video gallery page. * * @see http://schema.org/VideoGallery * - * @mixin \Spatie\SchemaOrg\CollectionPage */ -class VideoGallery extends BaseType +class VideoGallery extends BaseType implements CollectionPageContract, WebPageContract, CreativeWorkContract, ThingContract { + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/VideoGame.php b/src/VideoGame.php index 51e55a1a7..07629cd6b 100644 --- a/src/VideoGame.php +++ b/src/VideoGame.php @@ -2,16 +2,19 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; +use \Spatie\SchemaOrg\Contracts\GameContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A video game is an electronic game that involves human interaction with a * user interface to generate visual feedback on a video device. * * @see http://schema.org/VideoGame * - * @mixin \Spatie\SchemaOrg\SoftwareApplication - * @mixin \Spatie\SchemaOrg\Game */ -class VideoGame extends BaseType +class VideoGame extends BaseType implements SoftwareApplicationContract, GameContract, CreativeWorkContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -177,4 +180,1933 @@ public function trailer($trailer) return $this->setProperty('trailer', $trailer); } + /** + * Type of software application, e.g. 'Game, Multimedia'. + * + * @param string|string[] $applicationCategory + * + * @return static + * + * @see http://schema.org/applicationCategory + */ + public function applicationCategory($applicationCategory) + { + return $this->setProperty('applicationCategory', $applicationCategory); + } + + /** + * Subcategory of the application, e.g. 'Arcade Game'. + * + * @param string|string[] $applicationSubCategory + * + * @return static + * + * @see http://schema.org/applicationSubCategory + */ + public function applicationSubCategory($applicationSubCategory) + { + return $this->setProperty('applicationSubCategory', $applicationSubCategory); + } + + /** + * The name of the application suite to which the application belongs (e.g. + * Excel belongs to Office). + * + * @param string|string[] $applicationSuite + * + * @return static + * + * @see http://schema.org/applicationSuite + */ + public function applicationSuite($applicationSuite) + { + return $this->setProperty('applicationSuite', $applicationSuite); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $availableOnDevice + * + * @return static + * + * @see http://schema.org/availableOnDevice + */ + public function availableOnDevice($availableOnDevice) + { + return $this->setProperty('availableOnDevice', $availableOnDevice); + } + + /** + * Countries for which the application is not supported. You can also + * provide the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesNotSupported + * + * @return static + * + * @see http://schema.org/countriesNotSupported + */ + public function countriesNotSupported($countriesNotSupported) + { + return $this->setProperty('countriesNotSupported', $countriesNotSupported); + } + + /** + * Countries for which the application is supported. You can also provide + * the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesSupported + * + * @return static + * + * @see http://schema.org/countriesSupported + */ + public function countriesSupported($countriesSupported) + { + return $this->setProperty('countriesSupported', $countriesSupported); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $device + * + * @return static + * + * @see http://schema.org/device + */ + public function device($device) + { + return $this->setProperty('device', $device); + } + + /** + * If the file can be downloaded, URL to download the binary. + * + * @param string|string[] $downloadUrl + * + * @return static + * + * @see http://schema.org/downloadUrl + */ + public function downloadUrl($downloadUrl) + { + return $this->setProperty('downloadUrl', $downloadUrl); + } + + /** + * Features or modules provided by this application (and possibly required + * by other applications). + * + * @param string|string[] $featureList + * + * @return static + * + * @see http://schema.org/featureList + */ + public function featureList($featureList) + { + return $this->setProperty('featureList', $featureList); + } + + /** + * Size of the application / package (e.g. 18MB). In the absence of a unit + * (MB, KB etc.), KB will be assumed. + * + * @param string|string[] $fileSize + * + * @return static + * + * @see http://schema.org/fileSize + */ + public function fileSize($fileSize) + { + return $this->setProperty('fileSize', $fileSize); + } + + /** + * URL at which the app may be installed, if different from the URL of the + * item. + * + * @param string|string[] $installUrl + * + * @return static + * + * @see http://schema.org/installUrl + */ + public function installUrl($installUrl) + { + return $this->setProperty('installUrl', $installUrl); + } + + /** + * Minimum memory requirements. + * + * @param string|string[] $memoryRequirements + * + * @return static + * + * @see http://schema.org/memoryRequirements + */ + public function memoryRequirements($memoryRequirements) + { + return $this->setProperty('memoryRequirements', $memoryRequirements); + } + + /** + * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). + * + * @param string|string[] $operatingSystem + * + * @return static + * + * @see http://schema.org/operatingSystem + */ + public function operatingSystem($operatingSystem) + { + return $this->setProperty('operatingSystem', $operatingSystem); + } + + /** + * Permission(s) required to run the app (for example, a mobile app may + * require full internet access or may run only on wifi). + * + * @param string|string[] $permissions + * + * @return static + * + * @see http://schema.org/permissions + */ + public function permissions($permissions) + { + return $this->setProperty('permissions', $permissions); + } + + /** + * Processor architecture required to run the application (e.g. IA64). + * + * @param string|string[] $processorRequirements + * + * @return static + * + * @see http://schema.org/processorRequirements + */ + public function processorRequirements($processorRequirements) + { + return $this->setProperty('processorRequirements', $processorRequirements); + } + + /** + * Description of what changed in this version. + * + * @param string|string[] $releaseNotes + * + * @return static + * + * @see http://schema.org/releaseNotes + */ + public function releaseNotes($releaseNotes) + { + return $this->setProperty('releaseNotes', $releaseNotes); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $requirements + * + * @return static + * + * @see http://schema.org/requirements + */ + public function requirements($requirements) + { + return $this->setProperty('requirements', $requirements); + } + + /** + * A link to a screenshot image of the app. + * + * @param ImageObject|ImageObject[]|string|string[] $screenshot + * + * @return static + * + * @see http://schema.org/screenshot + */ + public function screenshot($screenshot) + { + return $this->setProperty('screenshot', $screenshot); + } + + /** + * Additional content for a software application. + * + * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn + * + * @return static + * + * @see http://schema.org/softwareAddOn + */ + public function softwareAddOn($softwareAddOn) + { + return $this->setProperty('softwareAddOn', $softwareAddOn); + } + + /** + * Software application help. + * + * @param CreativeWork|CreativeWork[] $softwareHelp + * + * @return static + * + * @see http://schema.org/softwareHelp + */ + public function softwareHelp($softwareHelp) + { + return $this->setProperty('softwareHelp', $softwareHelp); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $softwareRequirements + * + * @return static + * + * @see http://schema.org/softwareRequirements + */ + public function softwareRequirements($softwareRequirements) + { + return $this->setProperty('softwareRequirements', $softwareRequirements); + } + + /** + * Version of the software instance. + * + * @param string|string[] $softwareVersion + * + * @return static + * + * @see http://schema.org/softwareVersion + */ + public function softwareVersion($softwareVersion) + { + return $this->setProperty('softwareVersion', $softwareVersion); + } + + /** + * Storage requirements (free space required). + * + * @param string|string[] $storageRequirements + * + * @return static + * + * @see http://schema.org/storageRequirements + */ + public function storageRequirements($storageRequirements) + { + return $this->setProperty('storageRequirements', $storageRequirements); + } + + /** + * Supporting data for a SoftwareApplication. + * + * @param DataFeed|DataFeed[] $supportingData + * + * @return static + * + * @see http://schema.org/supportingData + */ + public function supportingData($supportingData) + { + return $this->setProperty('supportingData', $supportingData); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A piece of data that represents a particular aspect of a fictional + * character (skill, power, character points, advantage, disadvantage). + * + * @param Thing|Thing[] $characterAttribute + * + * @return static + * + * @see http://schema.org/characterAttribute + */ + public function characterAttribute($characterAttribute) + { + return $this->setProperty('characterAttribute', $characterAttribute); + } + + /** + * An item is an object within the game world that can be collected by a + * player or, occasionally, a non-player character. + * + * @param Thing|Thing[] $gameItem + * + * @return static + * + * @see http://schema.org/gameItem + */ + public function gameItem($gameItem) + { + return $this->setProperty('gameItem', $gameItem); + } + + /** + * Real or fictional location of the game (or part of game). + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $gameLocation + * + * @return static + * + * @see http://schema.org/gameLocation + */ + public function gameLocation($gameLocation) + { + return $this->setProperty('gameLocation', $gameLocation); + } + + /** + * Indicate how many people can play this game (minimum, maximum, or range). + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfPlayers + * + * @return static + * + * @see http://schema.org/numberOfPlayers + */ + public function numberOfPlayers($numberOfPlayers) + { + return $this->setProperty('numberOfPlayers', $numberOfPlayers); + } + + /** + * The task that a player-controlled character, or group of characters may + * complete in order to gain a reward. + * + * @param Thing|Thing[] $quest + * + * @return static + * + * @see http://schema.org/quest + */ + public function quest($quest) + { + return $this->setProperty('quest', $quest); + } + } diff --git a/src/VideoGameClip.php b/src/VideoGameClip.php index 16a4d5db0..a6bc37c44 100644 --- a/src/VideoGameClip.php +++ b/src/VideoGameClip.php @@ -2,13 +2,1653 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ClipContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A short segment/part of a video game. * * @see http://schema.org/VideoGameClip * - * @mixin \Spatie\SchemaOrg\Clip */ -class VideoGameClip extends BaseType +class VideoGameClip extends BaseType implements ClipContract, CreativeWorkContract, ThingContract { + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/VideoGameSeries.php b/src/VideoGameSeries.php index 0ca01f816..1194dd50e 100644 --- a/src/VideoGameSeries.php +++ b/src/VideoGameSeries.php @@ -2,14 +2,19 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A video game series. * * @see http://schema.org/VideoGameSeries * - * @mixin \Spatie\SchemaOrg\CreativeWorkSeries */ -class VideoGameSeries extends BaseType +class VideoGameSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -333,4 +338,1571 @@ public function trailer($trailer) return $this->setProperty('trailer', $trailer); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + } diff --git a/src/VideoObject.php b/src/VideoObject.php index 5c2cbabc2..f4057008f 100644 --- a/src/VideoObject.php +++ b/src/VideoObject.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A video file. * * @see http://schema.org/VideoObject * - * @mixin \Spatie\SchemaOrg\MediaObject */ -class VideoObject extends BaseType +class VideoObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { /** * An actor, e.g. in tv, radio, movie, video games etc., or in an event. @@ -160,4 +163,1760 @@ public function videoQuality($videoQuality) return $this->setProperty('videoQuality', $videoQuality); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Date when this media object was uploaded to this site. + * + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate + * + * @return static + * + * @see http://schema.org/uploadDate + */ + public function uploadDate($uploadDate) + { + return $this->setProperty('uploadDate', $uploadDate); + } + + /** + * The width of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * + * @return static + * + * @see http://schema.org/width + */ + public function width($width) + { + return $this->setProperty('width', $width); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/ViewAction.php b/src/ViewAction.php index c344482fc..167da341d 100644 --- a/src/ViewAction.php +++ b/src/ViewAction.php @@ -2,13 +2,413 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of consuming static visual content. * * @see http://schema.org/ViewAction * - * @mixin \Spatie\SchemaOrg\ConsumeAction */ -class ViewAction extends BaseType +class ViewAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/VisualArtsEvent.php b/src/VisualArtsEvent.php index 1878ea8ae..1b8b062d0 100644 --- a/src/VisualArtsEvent.php +++ b/src/VisualArtsEvent.php @@ -2,13 +2,726 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Event type: Visual arts event. * * @see http://schema.org/VisualArtsEvent * - * @mixin \Spatie\SchemaOrg\Event */ -class VisualArtsEvent extends BaseType +class VisualArtsEvent extends BaseType implements EventContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A person or organization attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendee + * + * @return static + * + * @see http://schema.org/attendee + */ + public function attendee($attendee) + { + return $this->setProperty('attendee', $attendee); + } + + /** + * A person attending the event. + * + * @param Organization|Organization[]|Person|Person[] $attendees + * + * @return static + * + * @see http://schema.org/attendees + */ + public function attendees($attendees) + { + return $this->setProperty('attendees', $attendees); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * The time admission will commence. + * + * @param \DateTimeInterface|\DateTimeInterface[] $doorTime + * + * @return static + * + * @see http://schema.org/doorTime + */ + public function doorTime($doorTime) + { + return $this->setProperty('doorTime', $doorTime); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An eventStatus of an event represents its status; particularly useful + * when an event is cancelled or rescheduled. + * + * @param EventStatusType|EventStatusType[] $eventStatus + * + * @return static + * + * @see http://schema.org/eventStatus + */ + public function eventStatus($eventStatus) + { + return $this->setProperty('eventStatus', $eventStatus); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * An organizer of an Event. + * + * @param Organization|Organization[]|Person|Person[] $organizer + * + * @return static + * + * @see http://schema.org/organizer + */ + public function organizer($organizer) + { + return $this->setProperty('organizer', $organizer); + } + + /** + * A performer at the event—for example, a presenter, musician, + * musical group or actor. + * + * @param Organization|Organization[]|Person|Person[] $performer + * + * @return static + * + * @see http://schema.org/performer + */ + public function performer($performer) + { + return $this->setProperty('performer', $performer); + } + + /** + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. + * + * @param Organization|Organization[]|Person|Person[] $performers + * + * @return static + * + * @see http://schema.org/performers + */ + public function performers($performers) + { + return $this->setProperty('performers', $performers); + } + + /** + * 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. + * + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * + * @return static + * + * @see http://schema.org/previousStartDate + */ + public function previousStartDate($previousStartDate) + { + return $this->setProperty('previousStartDate', $previousStartDate); + } + + /** + * The CreativeWork that captured all or part of this Event. + * + * @param CreativeWork|CreativeWork[] $recordedIn + * + * @return static + * + * @see http://schema.org/recordedIn + */ + public function recordedIn($recordedIn) + { + return $this->setProperty('recordedIn', $recordedIn); + } + + /** + * The number of attendee places for an event that remain unallocated. + * + * @param int|int[] $remainingAttendeeCapacity + * + * @return static + * + * @see http://schema.org/remainingAttendeeCapacity + */ + public function remainingAttendeeCapacity($remainingAttendeeCapacity) + { + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * 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. + * + * @param Event|Event[] $subEvent + * + * @return static + * + * @see http://schema.org/subEvent + */ + public function subEvent($subEvent) + { + return $this->setProperty('subEvent', $subEvent); + } + + /** + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. + * + * @param Event|Event[] $subEvents + * + * @return static + * + * @see http://schema.org/subEvents + */ + public function subEvents($subEvents) + { + return $this->setProperty('subEvents', $subEvents); + } + + /** + * 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. + * + * @param Event|Event[] $superEvent + * + * @return static + * + * @see http://schema.org/superEvent + */ + public function superEvent($superEvent) + { + return $this->setProperty('superEvent', $superEvent); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * 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). + * + * @param CreativeWork|CreativeWork[] $workFeatured + * + * @return static + * + * @see http://schema.org/workFeatured + */ + public function workFeatured($workFeatured) + { + return $this->setProperty('workFeatured', $workFeatured); + } + + /** + * A work performed in some event, for example a play performed in a + * TheaterEvent. + * + * @param CreativeWork|CreativeWork[] $workPerformed + * + * @return static + * + * @see http://schema.org/workPerformed + */ + public function workPerformed($workPerformed) + { + return $this->setProperty('workPerformed', $workPerformed); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/VisualArtwork.php b/src/VisualArtwork.php index d3070b021..751c9bd27 100644 --- a/src/VisualArtwork.php +++ b/src/VisualArtwork.php @@ -2,14 +2,16 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A work of art that is primarily visual in character. * * @see http://schema.org/VisualArtwork * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class VisualArtwork extends BaseType +class VisualArtwork extends BaseType implements CreativeWorkContract, ThingContract { /** * The number of copies when multiple copies of a piece of artwork are @@ -88,4 +90,1509 @@ public function surface($surface) return $this->setProperty('surface', $surface); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Volcano.php b/src/Volcano.php index 935e61177..9d78acbc1 100644 --- a/src/Volcano.php +++ b/src/Volcano.php @@ -2,13 +2,682 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A volcano, like Fuji san. * * @see http://schema.org/Volcano * - * @mixin \Spatie\SchemaOrg\Landform */ -class Volcano extends BaseType +class Volcano extends BaseType implements LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/VoteAction.php b/src/VoteAction.php index b3df3dbe5..a2e09a333 100644 --- a/src/VoteAction.php +++ b/src/VoteAction.php @@ -2,15 +2,19 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ChooseActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of expressing a preference from a fixed/finite/structured set of * choices/options. * * @see http://schema.org/VoteAction * - * @mixin \Spatie\SchemaOrg\ChooseAction */ -class VoteAction extends BaseType +class VoteAction extends BaseType implements ChooseActionContract, AssessActionContract, ActionContract, ThingContract { /** * A sub property of object. The candidate subject of this action. @@ -26,4 +30,397 @@ public function candidate($candidate) return $this->setProperty('candidate', $candidate); } + /** + * A sub property of object. The options subject to this action. + * + * @param Thing|Thing[]|string|string[] $actionOption + * + * @return static + * + * @see http://schema.org/actionOption + */ + public function actionOption($actionOption) + { + return $this->setProperty('actionOption', $actionOption); + } + + /** + * A sub property of object. The options subject to this action. + * + * @param Thing|Thing[]|string|string[] $option + * + * @return static + * + * @see http://schema.org/option + */ + public function option($option) + { + return $this->setProperty('option', $option); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WPAdBlock.php b/src/WPAdBlock.php index 9bf5a493f..c98ba1b7f 100644 --- a/src/WPAdBlock.php +++ b/src/WPAdBlock.php @@ -2,13 +2,1521 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * An advertising section of the page. * * @see http://schema.org/WPAdBlock * - * @mixin \Spatie\SchemaOrg\WebPageElement */ -class WPAdBlock extends BaseType +class WPAdBlock extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WPFooter.php b/src/WPFooter.php index 566700fc8..45feedf3e 100644 --- a/src/WPFooter.php +++ b/src/WPFooter.php @@ -2,13 +2,1521 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The footer section of the page. * * @see http://schema.org/WPFooter * - * @mixin \Spatie\SchemaOrg\WebPageElement */ -class WPFooter extends BaseType +class WPFooter extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WPHeader.php b/src/WPHeader.php index 5d363396e..b554de307 100644 --- a/src/WPHeader.php +++ b/src/WPHeader.php @@ -2,13 +2,1521 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The header section of the page. * * @see http://schema.org/WPHeader * - * @mixin \Spatie\SchemaOrg\WebPageElement */ -class WPHeader extends BaseType +class WPHeader extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WPSideBar.php b/src/WPSideBar.php index c141b4665..d8ce9c1b1 100644 --- a/src/WPSideBar.php +++ b/src/WPSideBar.php @@ -2,13 +2,1521 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A sidebar section of the page. * * @see http://schema.org/WPSideBar * - * @mixin \Spatie\SchemaOrg\WebPageElement */ -class WPSideBar extends BaseType +class WPSideBar extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WantAction.php b/src/WantAction.php index 4d157fe39..a1e954105 100644 --- a/src/WantAction.php +++ b/src/WantAction.php @@ -2,13 +2,382 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of expressing a desire about the object. An agent wants an object. * * @see http://schema.org/WantAction * - * @mixin \Spatie\SchemaOrg\ReactAction */ -class WantAction extends BaseType +class WantAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract { + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WarrantyPromise.php b/src/WarrantyPromise.php index fff5473bb..0eb487ea7 100644 --- a/src/WarrantyPromise.php +++ b/src/WarrantyPromise.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A structured value representing the duration and scope of services that will * be provided to a customer free of charge in case of a defect or malfunction @@ -9,9 +13,8 @@ * * @see http://schema.org/WarrantyPromise * - * @mixin \Spatie\SchemaOrg\StructuredValue */ -class WarrantyPromise extends BaseType +class WarrantyPromise extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** * The duration of the warranty promise. Common unitCode values are ANN for @@ -42,4 +45,190 @@ public function warrantyScope($warrantyScope) return $this->setProperty('warrantyScope', $warrantyScope); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WarrantyScope.php b/src/WarrantyScope.php index 36f409fea..392b34dad 100644 --- a/src/WarrantyScope.php +++ b/src/WarrantyScope.php @@ -2,6 +2,10 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A range of of services that will be provided to a customer free of charge in * case of a defect or malfunction of a product. @@ -14,8 +18,193 @@ * * @see http://schema.org/WarrantyScope * - * @mixin \Spatie\SchemaOrg\Enumeration */ -class WarrantyScope extends BaseType +class WarrantyScope extends BaseType implements EnumerationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WatchAction.php b/src/WatchAction.php index c63f06863..0c6c100be 100644 --- a/src/WatchAction.php +++ b/src/WatchAction.php @@ -2,13 +2,413 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of consuming dynamic/moving visual content. * * @see http://schema.org/WatchAction * - * @mixin \Spatie\SchemaOrg\ConsumeAction */ -class WatchAction extends BaseType +class WatchAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Waterfall.php b/src/Waterfall.php index 00aae9221..c75a9c139 100644 --- a/src/Waterfall.php +++ b/src/Waterfall.php @@ -2,13 +2,683 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\BodyOfWaterContract; +use \Spatie\SchemaOrg\Contracts\LandformContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A waterfall, like Niagara. * * @see http://schema.org/Waterfall * - * @mixin \Spatie\SchemaOrg\BodyOfWater */ -class Waterfall extends BaseType +class Waterfall extends BaseType implements BodyOfWaterContract, LandformContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WearAction.php b/src/WearAction.php index e27106112..6c97209f9 100644 --- a/src/WearAction.php +++ b/src/WearAction.php @@ -2,13 +2,414 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\UseActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of dressing oneself in clothing. * * @see http://schema.org/WearAction * - * @mixin \Spatie\SchemaOrg\UseAction */ -class WearAction extends BaseType +class WearAction extends BaseType implements UseActionContract, ConsumeActionContract, ActionContract, ThingContract { + /** + * A set of requirements that a must be fulfilled in order to perform an + * Action. If more than one value is specied, fulfilling one set of + * requirements will allow the Action to be performed. + * + * @param ActionAccessSpecification|ActionAccessSpecification[] $actionAccessibilityRequirement + * + * @return static + * + * @see http://schema.org/actionAccessibilityRequirement + */ + public function actionAccessibilityRequirement($actionAccessibilityRequirement) + { + return $this->setProperty('actionAccessibilityRequirement', $actionAccessibilityRequirement); + } + + /** + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. + * + * @param Offer|Offer[] $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WebApplication.php b/src/WebApplication.php index a7a82d84b..b063f66c4 100644 --- a/src/WebApplication.php +++ b/src/WebApplication.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * Web applications. * * @see http://schema.org/WebApplication * - * @mixin \Spatie\SchemaOrg\SoftwareApplication */ -class WebApplication extends BaseType +class WebApplication extends BaseType implements SoftwareApplicationContract, CreativeWorkContract, ThingContract { /** * Specifies browser requirements in human-readable text. For example, @@ -26,4 +29,1860 @@ public function browserRequirements($browserRequirements) return $this->setProperty('browserRequirements', $browserRequirements); } + /** + * Type of software application, e.g. 'Game, Multimedia'. + * + * @param string|string[] $applicationCategory + * + * @return static + * + * @see http://schema.org/applicationCategory + */ + public function applicationCategory($applicationCategory) + { + return $this->setProperty('applicationCategory', $applicationCategory); + } + + /** + * Subcategory of the application, e.g. 'Arcade Game'. + * + * @param string|string[] $applicationSubCategory + * + * @return static + * + * @see http://schema.org/applicationSubCategory + */ + public function applicationSubCategory($applicationSubCategory) + { + return $this->setProperty('applicationSubCategory', $applicationSubCategory); + } + + /** + * The name of the application suite to which the application belongs (e.g. + * Excel belongs to Office). + * + * @param string|string[] $applicationSuite + * + * @return static + * + * @see http://schema.org/applicationSuite + */ + public function applicationSuite($applicationSuite) + { + return $this->setProperty('applicationSuite', $applicationSuite); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $availableOnDevice + * + * @return static + * + * @see http://schema.org/availableOnDevice + */ + public function availableOnDevice($availableOnDevice) + { + return $this->setProperty('availableOnDevice', $availableOnDevice); + } + + /** + * Countries for which the application is not supported. You can also + * provide the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesNotSupported + * + * @return static + * + * @see http://schema.org/countriesNotSupported + */ + public function countriesNotSupported($countriesNotSupported) + { + return $this->setProperty('countriesNotSupported', $countriesNotSupported); + } + + /** + * Countries for which the application is supported. You can also provide + * the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesSupported + * + * @return static + * + * @see http://schema.org/countriesSupported + */ + public function countriesSupported($countriesSupported) + { + return $this->setProperty('countriesSupported', $countriesSupported); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $device + * + * @return static + * + * @see http://schema.org/device + */ + public function device($device) + { + return $this->setProperty('device', $device); + } + + /** + * If the file can be downloaded, URL to download the binary. + * + * @param string|string[] $downloadUrl + * + * @return static + * + * @see http://schema.org/downloadUrl + */ + public function downloadUrl($downloadUrl) + { + return $this->setProperty('downloadUrl', $downloadUrl); + } + + /** + * Features or modules provided by this application (and possibly required + * by other applications). + * + * @param string|string[] $featureList + * + * @return static + * + * @see http://schema.org/featureList + */ + public function featureList($featureList) + { + return $this->setProperty('featureList', $featureList); + } + + /** + * Size of the application / package (e.g. 18MB). In the absence of a unit + * (MB, KB etc.), KB will be assumed. + * + * @param string|string[] $fileSize + * + * @return static + * + * @see http://schema.org/fileSize + */ + public function fileSize($fileSize) + { + return $this->setProperty('fileSize', $fileSize); + } + + /** + * URL at which the app may be installed, if different from the URL of the + * item. + * + * @param string|string[] $installUrl + * + * @return static + * + * @see http://schema.org/installUrl + */ + public function installUrl($installUrl) + { + return $this->setProperty('installUrl', $installUrl); + } + + /** + * Minimum memory requirements. + * + * @param string|string[] $memoryRequirements + * + * @return static + * + * @see http://schema.org/memoryRequirements + */ + public function memoryRequirements($memoryRequirements) + { + return $this->setProperty('memoryRequirements', $memoryRequirements); + } + + /** + * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). + * + * @param string|string[] $operatingSystem + * + * @return static + * + * @see http://schema.org/operatingSystem + */ + public function operatingSystem($operatingSystem) + { + return $this->setProperty('operatingSystem', $operatingSystem); + } + + /** + * Permission(s) required to run the app (for example, a mobile app may + * require full internet access or may run only on wifi). + * + * @param string|string[] $permissions + * + * @return static + * + * @see http://schema.org/permissions + */ + public function permissions($permissions) + { + return $this->setProperty('permissions', $permissions); + } + + /** + * Processor architecture required to run the application (e.g. IA64). + * + * @param string|string[] $processorRequirements + * + * @return static + * + * @see http://schema.org/processorRequirements + */ + public function processorRequirements($processorRequirements) + { + return $this->setProperty('processorRequirements', $processorRequirements); + } + + /** + * Description of what changed in this version. + * + * @param string|string[] $releaseNotes + * + * @return static + * + * @see http://schema.org/releaseNotes + */ + public function releaseNotes($releaseNotes) + { + return $this->setProperty('releaseNotes', $releaseNotes); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $requirements + * + * @return static + * + * @see http://schema.org/requirements + */ + public function requirements($requirements) + { + return $this->setProperty('requirements', $requirements); + } + + /** + * A link to a screenshot image of the app. + * + * @param ImageObject|ImageObject[]|string|string[] $screenshot + * + * @return static + * + * @see http://schema.org/screenshot + */ + public function screenshot($screenshot) + { + return $this->setProperty('screenshot', $screenshot); + } + + /** + * Additional content for a software application. + * + * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn + * + * @return static + * + * @see http://schema.org/softwareAddOn + */ + public function softwareAddOn($softwareAddOn) + { + return $this->setProperty('softwareAddOn', $softwareAddOn); + } + + /** + * Software application help. + * + * @param CreativeWork|CreativeWork[] $softwareHelp + * + * @return static + * + * @see http://schema.org/softwareHelp + */ + public function softwareHelp($softwareHelp) + { + return $this->setProperty('softwareHelp', $softwareHelp); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $softwareRequirements + * + * @return static + * + * @see http://schema.org/softwareRequirements + */ + public function softwareRequirements($softwareRequirements) + { + return $this->setProperty('softwareRequirements', $softwareRequirements); + } + + /** + * Version of the software instance. + * + * @param string|string[] $softwareVersion + * + * @return static + * + * @see http://schema.org/softwareVersion + */ + public function softwareVersion($softwareVersion) + { + return $this->setProperty('softwareVersion', $softwareVersion); + } + + /** + * Storage requirements (free space required). + * + * @param string|string[] $storageRequirements + * + * @return static + * + * @see http://schema.org/storageRequirements + */ + public function storageRequirements($storageRequirements) + { + return $this->setProperty('storageRequirements', $storageRequirements); + } + + /** + * Supporting data for a SoftwareApplication. + * + * @param DataFeed|DataFeed[] $supportingData + * + * @return static + * + * @see http://schema.org/supportingData + */ + public function supportingData($supportingData) + { + return $this->setProperty('supportingData', $supportingData); + } + + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WebPage.php b/src/WebPage.php index f508c80ce..33bd00288 100644 --- a/src/WebPage.php +++ b/src/WebPage.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A web page. Every web page is implicitly assumed to be declared to be of type * WebPage, so the various properties about that webpage, such as @@ -11,9 +14,8 @@ * * @see http://schema.org/WebPage * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class WebPage extends BaseType +class WebPage extends BaseType implements CreativeWorkContract, ThingContract { /** * A set of links that can help a user understand and navigate a website @@ -185,4 +187,1509 @@ public function specialty($specialty) return $this->setProperty('specialty', $specialty); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WebPageElement.php b/src/WebPageElement.php index 9c9abc194..124b418b3 100644 --- a/src/WebPageElement.php +++ b/src/WebPageElement.php @@ -2,15 +2,1522 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A web page element, like a table or an image. * * @see http://schema.org/WebPageElement * - * @mixin \Spatie\SchemaOrg\CreativeWork * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ -class WebPageElement extends BaseType +class WebPageElement extends BaseType implements CreativeWorkContract, ThingContract { + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WebSite.php b/src/WebSite.php index db0d19852..905c4ed10 100644 --- a/src/WebSite.php +++ b/src/WebSite.php @@ -2,15 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A WebSite is a set of related web pages and other items typically served from * a single web domain and accessible via URLs. * * @see http://schema.org/WebSite * - * @mixin \Spatie\SchemaOrg\CreativeWork */ -class WebSite extends BaseType +class WebSite extends BaseType implements CreativeWorkContract, ThingContract { /** * The International Standard Serial Number (ISSN) that identifies this @@ -28,4 +30,1509 @@ public function issn($issn) return $this->setProperty('issn', $issn); } + /** + * The subject matter of the content. + * + * @param Thing|Thing[] $about + * + * @return static + * + * @see http://schema.org/about + */ + public function about($about) + { + return $this->setProperty('about', $about); + } + + /** + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * + * @param string|string[] $accessMode + * + * @return static + * + * @see http://schema.org/accessMode + */ + public function accessMode($accessMode) + { + return $this->setProperty('accessMode', $accessMode); + } + + /** + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. + * + * @param ItemList|ItemList[] $accessModeSufficient + * + * @return static + * + * @see http://schema.org/accessModeSufficient + */ + public function accessModeSufficient($accessModeSufficient) + { + return $this->setProperty('accessModeSufficient', $accessModeSufficient); + } + + /** + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityAPI + * + * @return static + * + * @see http://schema.org/accessibilityAPI + */ + public function accessibilityAPI($accessibilityAPI) + { + return $this->setProperty('accessibilityAPI', $accessibilityAPI); + } + + /** + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityControl + * + * @return static + * + * @see http://schema.org/accessibilityControl + */ + public function accessibilityControl($accessibilityControl) + { + return $this->setProperty('accessibilityControl', $accessibilityControl); + } + + /** + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityFeature + * + * @return static + * + * @see http://schema.org/accessibilityFeature + */ + public function accessibilityFeature($accessibilityFeature) + { + return $this->setProperty('accessibilityFeature', $accessibilityFeature); + } + + /** + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * + * @param string|string[] $accessibilityHazard + * + * @return static + * + * @see http://schema.org/accessibilityHazard + */ + public function accessibilityHazard($accessibilityHazard) + { + return $this->setProperty('accessibilityHazard', $accessibilityHazard); + } + + /** + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." + * + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * A secondary title of the CreativeWork. + * + * @param string|string[] $alternativeHeadline + * + * @return static + * + * @see http://schema.org/alternativeHeadline + */ + public function alternativeHeadline($alternativeHeadline) + { + return $this->setProperty('alternativeHeadline', $alternativeHeadline); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. + * + * @param MediaObject|MediaObject[] $associatedMedia + * + * @return static + * + * @see http://schema.org/associatedMedia + */ + public function associatedMedia($associatedMedia) + { + return $this->setProperty('associatedMedia', $associatedMedia); + } + + /** + * An intended audience, i.e. a group for whom something was created. + * + * @param Audience|Audience[] $audience + * + * @return static + * + * @see http://schema.org/audience + */ + public function audience($audience) + { + return $this->setProperty('audience', $audience); + } + + /** + * An embedded audio object. + * + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * + * @return static + * + * @see http://schema.org/audio + */ + public function audio($audio) + { + return $this->setProperty('audio', $audio); + } + + /** + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. + * + * @param Organization|Organization[]|Person|Person[] $author + * + * @return static + * + * @see http://schema.org/author + */ + public function author($author) + { + return $this->setProperty('author', $author); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * Fictional person connected with a creative work. + * + * @param Person|Person[] $character + * + * @return static + * + * @see http://schema.org/character + */ + public function character($character) + { + return $this->setProperty('character', $character); + } + + /** + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. + * + * @param CreativeWork|CreativeWork[]|string|string[] $citation + * + * @return static + * + * @see http://schema.org/citation + */ + public function citation($citation) + { + return $this->setProperty('citation', $citation); + } + + /** + * Comments, typically from users. + * + * @param Comment|Comment[] $comment + * + * @return static + * + * @see http://schema.org/comment + */ + public function comment($comment) + { + return $this->setProperty('comment', $comment); + } + + /** + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. + * + * @param int|int[] $commentCount + * + * @return static + * + * @see http://schema.org/commentCount + */ + public function commentCount($commentCount) + { + return $this->setProperty('commentCount', $commentCount); + } + + /** + * The location depicted or described in the content. For example, the + * location in a photograph or painting. + * + * @param Place|Place[] $contentLocation + * + * @return static + * + * @see http://schema.org/contentLocation + */ + public function contentLocation($contentLocation) + { + return $this->setProperty('contentLocation', $contentLocation); + } + + /** + * Official rating of a piece of content—for example,'MPAA PG-13'. + * + * @param Rating|Rating[]|string|string[] $contentRating + * + * @return static + * + * @see http://schema.org/contentRating + */ + public function contentRating($contentRating) + { + return $this->setProperty('contentRating', $contentRating); + } + + /** + * A secondary contributor to the CreativeWork or Event. + * + * @param Organization|Organization[]|Person|Person[] $contributor + * + * @return static + * + * @see http://schema.org/contributor + */ + public function contributor($contributor) + { + return $this->setProperty('contributor', $contributor); + } + + /** + * The party holding the legal copyright to the CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * + * @return static + * + * @see http://schema.org/copyrightHolder + */ + public function copyrightHolder($copyrightHolder) + { + return $this->setProperty('copyrightHolder', $copyrightHolder); + } + + /** + * The year during which the claimed copyright for the CreativeWork was + * first asserted. + * + * @param float|float[]|int|int[] $copyrightYear + * + * @return static + * + * @see http://schema.org/copyrightYear + */ + public function copyrightYear($copyrightYear) + { + return $this->setProperty('copyrightYear', $copyrightYear); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * + * @return static + * + * @see http://schema.org/dateCreated + */ + public function dateCreated($dateCreated) + { + return $this->setProperty('dateCreated', $dateCreated); + } + + /** + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + + /** + * A media object that encodes this CreativeWork. + * + * @param MediaObject|MediaObject[] $encodings + * + * @return static + * + * @see http://schema.org/encodings + */ + public function encodings($encodings) + { + return $this->setProperty('encodings', $encodings); + } + + /** + * A creative work that this work is an + * example/instance/realization/derivation of. + * + * @param CreativeWork|CreativeWork[] $exampleOfWork + * + * @return static + * + * @see http://schema.org/exampleOfWork + */ + public function exampleOfWork($exampleOfWork) + { + return $this->setProperty('exampleOfWork', $exampleOfWork); + } + + /** + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. + * + * @param \DateTimeInterface|\DateTimeInterface[] $expires + * + * @return static + * + * @see http://schema.org/expires + */ + public function expires($expires) + { + return $this->setProperty('expires', $expires); + } + + /** + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. + * + * @param string|string[] $fileFormat + * + * @return static + * + * @see http://schema.org/fileFormat + */ + public function fileFormat($fileFormat) + { + return $this->setProperty('fileFormat', $fileFormat); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * + * @return static + * + * @see http://schema.org/isBasedOn + */ + public function isBasedOn($isBasedOn) + { + return $this->setProperty('isBasedOn', $isBasedOn); + } + + /** + * A resource that was used in the creation of this resource. This term can + * be repeated for multiple sources. For example, + * http://example.com/great-multiplication-intro.html. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOnUrl + * + * @return static + * + * @see http://schema.org/isBasedOnUrl + */ + public function isBasedOnUrl($isBasedOnUrl) + { + return $this->setProperty('isBasedOnUrl', $isBasedOnUrl); + } + + /** + * Indicates whether this content is family friendly. + * + * @param bool|bool[] $isFamilyFriendly + * + * @return static + * + * @see http://schema.org/isFamilyFriendly + */ + public function isFamilyFriendly($isFamilyFriendly) + { + return $this->setProperty('isFamilyFriendly', $isFamilyFriendly); + } + + /** + * Indicates an item or CreativeWork that this item, or CreativeWork (in + * some sense), is part of. + * + * @param CreativeWork|CreativeWork[] $isPartOf + * + * @return static + * + * @see http://schema.org/isPartOf + */ + public function isPartOf($isPartOf) + { + return $this->setProperty('isPartOf', $isPartOf); + } + + /** + * Keywords or tags used to describe this content. Multiple entries in a + * keywords list are typically delimited by commas. + * + * @param string|string[] $keywords + * + * @return static + * + * @see http://schema.org/keywords + */ + public function keywords($keywords) + { + return $this->setProperty('keywords', $keywords); + } + + /** + * The predominant type or kind characterizing the learning resource. For + * example, 'presentation', 'handout'. + * + * @param string|string[] $learningResourceType + * + * @return static + * + * @see http://schema.org/learningResourceType + */ + public function learningResourceType($learningResourceType) + { + return $this->setProperty('learningResourceType', $learningResourceType); + } + + /** + * A license document that applies to this content, typically indicated by + * URL. + * + * @param CreativeWork|CreativeWork[]|string|string[] $license + * + * @return static + * + * @see http://schema.org/license + */ + public function license($license) + { + return $this->setProperty('license', $license); + } + + /** + * The location where the CreativeWork was created, which may not be the + * same as the location depicted in the CreativeWork. + * + * @param Place|Place[] $locationCreated + * + * @return static + * + * @see http://schema.org/locationCreated + */ + public function locationCreated($locationCreated) + { + return $this->setProperty('locationCreated', $locationCreated); + } + + /** + * Indicates the primary entity described in some page or other + * CreativeWork. + * + * @param Thing|Thing[] $mainEntity + * + * @return static + * + * @see http://schema.org/mainEntity + */ + public function mainEntity($mainEntity) + { + return $this->setProperty('mainEntity', $mainEntity); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * Indicates that the CreativeWork contains a reference to, but is not + * necessarily about a concept. + * + * @param Thing|Thing[] $mentions + * + * @return static + * + * @see http://schema.org/mentions + */ + public function mentions($mentions) + { + return $this->setProperty('mentions', $mentions); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer + * + * @return static + * + * @see http://schema.org/producer + */ + public function producer($producer) + { + return $this->setProperty('producer', $producer); + } + + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + + /** + * A publication event associated with the item. + * + * @param PublicationEvent|PublicationEvent[] $publication + * + * @return static + * + * @see http://schema.org/publication + */ + public function publication($publication) + { + return $this->setProperty('publication', $publication); + } + + /** + * The publisher of the creative work. + * + * @param Organization|Organization[]|Person|Person[] $publisher + * + * @return static + * + * @see http://schema.org/publisher + */ + public function publisher($publisher) + { + return $this->setProperty('publisher', $publisher); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * The Event where the CreativeWork was recorded. The CreativeWork may + * capture all or part of the event. + * + * @param Event|Event[] $recordedAt + * + * @return static + * + * @see http://schema.org/recordedAt + */ + public function recordedAt($recordedAt) + { + return $this->setProperty('recordedAt', $recordedAt); + } + + /** + * The place and time the release was issued, expressed as a + * PublicationEvent. + * + * @param PublicationEvent|PublicationEvent[] $releasedEvent + * + * @return static + * + * @see http://schema.org/releasedEvent + */ + public function releasedEvent($releasedEvent) + { + return $this->setProperty('releasedEvent', $releasedEvent); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * The Organization on whose behalf the creator was working. + * + * @param Organization|Organization[] $sourceOrganization + * + * @return static + * + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage + * + * @return static + * + * @see http://schema.org/temporalCoverage + */ + public function temporalCoverage($temporalCoverage) + { + return $this->setProperty('temporalCoverage', $temporalCoverage); + } + + /** + * The textual content of this CreativeWork. + * + * @param string|string[] $text + * + * @return static + * + * @see http://schema.org/text + */ + public function text($text) + { + return $this->setProperty('text', $text); + } + + /** + * A thumbnail image relevant to the Thing. + * + * @param string|string[] $thumbnailUrl + * + * @return static + * + * @see http://schema.org/thumbnailUrl + */ + public function thumbnailUrl($thumbnailUrl) + { + return $this->setProperty('thumbnailUrl', $thumbnailUrl); + } + + /** + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. + * + * @param Duration|Duration[] $timeRequired + * + * @return static + * + * @see http://schema.org/timeRequired + */ + public function timeRequired($timeRequired) + { + return $this->setProperty('timeRequired', $timeRequired); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $translator + * + * @return static + * + * @see http://schema.org/translator + */ + public function translator($translator) + { + return $this->setProperty('translator', $translator); + } + + /** + * The typical expected age range, e.g. '7-9', '11-'. + * + * @param string|string[] $typicalAgeRange + * + * @return static + * + * @see http://schema.org/typicalAgeRange + */ + public function typicalAgeRange($typicalAgeRange) + { + return $this->setProperty('typicalAgeRange', $typicalAgeRange); + } + + /** + * The version of the CreativeWork embodied by a specified resource. + * + * @param float|float[]|int|int[]|string|string[] $version + * + * @return static + * + * @see http://schema.org/version + */ + public function version($version) + { + return $this->setProperty('version', $version); + } + + /** + * An embedded video object. + * + * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * + * @return static + * + * @see http://schema.org/video + */ + public function video($video) + { + return $this->setProperty('video', $video); + } + + /** + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. + * + * @param CreativeWork|CreativeWork[] $workExample + * + * @return static + * + * @see http://schema.org/workExample + */ + public function workExample($workExample) + { + return $this->setProperty('workExample', $workExample); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WholesaleStore.php b/src/WholesaleStore.php index 8b4d79570..af0e15922 100644 --- a/src/WholesaleStore.php +++ b/src/WholesaleStore.php @@ -2,13 +2,1339 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\StoreContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A wholesale store. * * @see http://schema.org/WholesaleStore * - * @mixin \Spatie\SchemaOrg\Store */ -class WholesaleStore extends BaseType +class WholesaleStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/WinAction.php b/src/WinAction.php index ae1e1189f..0532cf2e0 100644 --- a/src/WinAction.php +++ b/src/WinAction.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\AchieveActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of achieving victory in a competitive activity. * * @see http://schema.org/WinAction * - * @mixin \Spatie\SchemaOrg\AchieveAction */ -class WinAction extends BaseType +class WinAction extends BaseType implements AchieveActionContract, ActionContract, ThingContract { /** * A sub property of participant. The loser of the action. @@ -25,4 +28,369 @@ public function loser($loser) return $this->setProperty('loser', $loser); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Winery.php b/src/Winery.php index d681eab47..4d89a9e87 100644 --- a/src/Winery.php +++ b/src/Winery.php @@ -2,13 +2,1416 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\FoodEstablishmentContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A winery. * * @see http://schema.org/Winery * - * @mixin \Spatie\SchemaOrg\FoodEstablishment */ -class Winery extends BaseType +class Winery extends BaseType implements FoodEstablishmentContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * Indicates whether a FoodEstablishment accepts reservations. Values can be + * Boolean, an URL at which reservations can be made or (for backwards + * compatibility) the strings ```Yes``` or ```No```. + * + * @param bool|bool[]|string|string[] $acceptsReservations + * + * @return static + * + * @see http://schema.org/acceptsReservations + */ + public function acceptsReservations($acceptsReservations) + { + return $this->setProperty('acceptsReservations', $acceptsReservations); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $hasMenu + * + * @return static + * + * @see http://schema.org/hasMenu + */ + public function hasMenu($hasMenu) + { + return $this->setProperty('hasMenu', $hasMenu); + } + + /** + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. + * + * @param Menu|Menu[]|string|string[] $menu + * + * @return static + * + * @see http://schema.org/menu + */ + public function menu($menu) + { + return $this->setProperty('menu', $menu); + } + + /** + * The cuisine of the restaurant. + * + * @param string|string[] $servesCuisine + * + * @return static + * + * @see http://schema.org/servesCuisine + */ + public function servesCuisine($servesCuisine) + { + return $this->setProperty('servesCuisine', $servesCuisine); + } + + /** + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * + * @param Rating|Rating[] $starRating + * + * @return static + * + * @see http://schema.org/starRating + */ + public function starRating($starRating) + { + return $this->setProperty('starRating', $starRating); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * + * @param string|string[] $paymentAccepted + * + * @return static + * + * @see http://schema.org/paymentAccepted + */ + public function paymentAccepted($paymentAccepted) + { + return $this->setProperty('paymentAccepted', $paymentAccepted); + } + + /** + * The price range of the business, for example ```$$$```. + * + * @param string|string[] $priceRange + * + * @return static + * + * @see http://schema.org/priceRange + */ + public function priceRange($priceRange) + { + return $this->setProperty('priceRange', $priceRange); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + } diff --git a/src/WorkersUnion.php b/src/WorkersUnion.php index e700c7670..36f0e2717 100644 --- a/src/WorkersUnion.php +++ b/src/WorkersUnion.php @@ -2,6 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A Workers Union (also known as a Labor Union, Labour Union, or Trade Union) * is an organization that promotes the interests of its worker members by @@ -9,8 +12,929 @@ * * @see http://schema.org/WorkersUnion * - * @mixin \Spatie\SchemaOrg\Organization */ -class WorkersUnion extends BaseType +class WorkersUnion extends BaseType implements OrganizationContract, ThingContract { + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. + * + * @param Brand|Brand[]|Organization|Organization[] $brand + * + * @return static + * + * @see http://schema.org/brand + */ + public function brand($brand) + { + return $this->setProperty('brand', $brand); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoint + * + * @return static + * + * @see http://schema.org/contactPoint + */ + public function contactPoint($contactPoint) + { + return $this->setProperty('contactPoint', $contactPoint); + } + + /** + * A contact point for a person or organization. + * + * @param ContactPoint|ContactPoint[] $contactPoints + * + * @return static + * + * @see http://schema.org/contactPoints + */ + public function contactPoints($contactPoints) + { + return $this->setProperty('contactPoints', $contactPoints); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * The date that this organization was dissolved. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * + * @return static + * + * @see http://schema.org/dissolutionDate + */ + public function dissolutionDate($dissolutionDate) + { + return $this->setProperty('dissolutionDate', $dissolutionDate); + } + + /** + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. + * + * @param string|string[] $duns + * + * @return static + * + * @see http://schema.org/duns + */ + public function duns($duns) + { + return $this->setProperty('duns', $duns); + } + + /** + * Email address. + * + * @param string|string[] $email + * + * @return static + * + * @see http://schema.org/email + */ + public function email($email) + { + return $this->setProperty('email', $email); + } + + /** + * Someone working for this organization. + * + * @param Person|Person[] $employee + * + * @return static + * + * @see http://schema.org/employee + */ + public function employee($employee) + { + return $this->setProperty('employee', $employee); + } + + /** + * People working for this organization. + * + * @param Person|Person[] $employees + * + * @return static + * + * @see http://schema.org/employees + */ + public function employees($employees) + { + return $this->setProperty('employees', $employees); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founder + * + * @return static + * + * @see http://schema.org/founder + */ + public function founder($founder) + { + return $this->setProperty('founder', $founder); + } + + /** + * A person who founded this organization. + * + * @param Person|Person[] $founders + * + * @return static + * + * @see http://schema.org/founders + */ + public function founders($founders) + { + return $this->setProperty('founders', $founders); + } + + /** + * The date that this organization was founded. + * + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * + * @return static + * + * @see http://schema.org/foundingDate + */ + public function foundingDate($foundingDate) + { + return $this->setProperty('foundingDate', $foundingDate); + } + + /** + * The place where the Organization was founded. + * + * @param Place|Place[] $foundingLocation + * + * @return static + * + * @see http://schema.org/foundingLocation + */ + public function foundingLocation($foundingLocation) + { + return $this->setProperty('foundingLocation', $foundingLocation); + } + + /** + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. + * + * @param Organization|Organization[]|Person|Person[] $funder + * + * @return static + * + * @see http://schema.org/funder + */ + public function funder($funder) + { + return $this->setProperty('funder', $funder); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. + * + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * + * @return static + * + * @see http://schema.org/hasOfferCatalog + */ + public function hasOfferCatalog($hasOfferCatalog) + { + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) + { + return $this->setProperty('legalName', $legalName); + } + + /** + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. + * + * @param string|string[] $leiCode + * + * @return static + * + * @see http://schema.org/leiCode + */ + public function leiCode($leiCode) + { + return $this->setProperty('leiCode', $leiCode); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * A pointer to products or services offered by the organization or person. + * + * @param Offer|Offer[] $makesOffer + * + * @return static + * + * @see http://schema.org/makesOffer + */ + public function makesOffer($makesOffer) + { + return $this->setProperty('makesOffer', $makesOffer); + } + + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. + * + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * + * @return static + * + * @see http://schema.org/memberOf + */ + public function memberOf($memberOf) + { + return $this->setProperty('memberOf', $memberOf); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. + * + * @param string|string[] $naics + * + * @return static + * + * @see http://schema.org/naics + */ + public function naics($naics) + { + return $this->setProperty('naics', $naics); + } + + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + + /** + * A pointer to the organization or person making the offer. + * + * @param Organization|Organization[]|Person|Person[] $offeredBy + * + * @return static + * + * @see http://schema.org/offeredBy + */ + public function offeredBy($offeredBy) + { + return $this->setProperty('offeredBy', $offeredBy); + } + + /** + * Products owned by the organization or person. + * + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * + * @return static + * + * @see http://schema.org/owns + */ + public function owns($owns) + { + return $this->setProperty('owns', $owns); + } + + /** + * The larger organization that this organization is a [[subOrganization]] + * of, if any. + * + * @param Organization|Organization[] $parentOrganization + * + * @return static + * + * @see http://schema.org/parentOrganization + */ + public function parentOrganization($parentOrganization) + { + return $this->setProperty('parentOrganization', $parentOrganization); + } + + /** + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. + * + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * + * @return static + * + * @see http://schema.org/publishingPrinciples + */ + public function publishingPrinciples($publishingPrinciples) + { + return $this->setProperty('publishingPrinciples', $publishingPrinciples); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A pointer to products or services sought by the organization or person + * (demand). + * + * @param Demand|Demand[] $seeks + * + * @return static + * + * @see http://schema.org/seeks + */ + public function seeks($seeks) + { + return $this->setProperty('seeks', $seeks); + } + + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. + * + * @param Organization|Organization[] $subOrganization + * + * @return static + * + * @see http://schema.org/subOrganization + */ + public function subOrganization($subOrganization) + { + return $this->setProperty('subOrganization', $subOrganization); + } + + /** + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. + * + * @param string|string[] $taxID + * + * @return static + * + * @see http://schema.org/taxID + */ + public function taxID($taxID) + { + return $this->setProperty('taxID', $taxID); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * The Value-added Tax ID of the organization or person. + * + * @param string|string[] $vatID + * + * @return static + * + * @see http://schema.org/vatID + */ + public function vatID($vatID) + { + return $this->setProperty('vatID', $vatID); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/WriteAction.php b/src/WriteAction.php index d2094eda2..e7329dbaf 100644 --- a/src/WriteAction.php +++ b/src/WriteAction.php @@ -2,14 +2,17 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * The act of authoring written creative content. * * @see http://schema.org/WriteAction * - * @mixin \Spatie\SchemaOrg\CreateAction */ -class WriteAction extends BaseType +class WriteAction extends BaseType implements CreateActionContract, ActionContract, ThingContract { /** * The language of the content or performance or used in an action. Please @@ -42,4 +45,369 @@ public function language($language) return $this->setProperty('language', $language); } + /** + * Indicates the current disposition of the Action. + * + * @param ActionStatusType|ActionStatusType[] $actionStatus + * + * @return static + * + * @see http://schema.org/actionStatus + */ + public function actionStatus($actionStatus) + { + return $this->setProperty('actionStatus', $actionStatus); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); + } + + /** + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. + * + * @param Thing|Thing[] $instrument + * + * @return static + * + * @see http://schema.org/instrument + */ + public function instrument($instrument) + { + return $this->setProperty('instrument', $instrument); + } + + /** + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * + * @return static + * + * @see http://schema.org/location + */ + public function location($location) + { + return $this->setProperty('location', $location); + } + + /** + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. + * + * @param Thing|Thing[] $object + * + * @return static + * + * @see http://schema.org/object + */ + public function object($object) + { + return $this->setProperty('object', $object); + } + + /** + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. + * + * @param Organization|Organization[]|Person|Person[] $participant + * + * @return static + * + * @see http://schema.org/participant + */ + public function participant($participant) + { + return $this->setProperty('participant', $participant); + } + + /** + * The result produced in the action. e.g. John wrote *a book*. + * + * @param Thing|Thing[] $result + * + * @return static + * + * @see http://schema.org/result + */ + public function result($result) + { + return $this->setProperty('result', $result); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } diff --git a/src/Zoo.php b/src/Zoo.php index 899cb4d47..f0f533b27 100644 --- a/src/Zoo.php +++ b/src/Zoo.php @@ -2,13 +2,711 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; + /** * A zoo. * * @see http://schema.org/Zoo * - * @mixin \Spatie\SchemaOrg\CivicStructure */ -class Zoo extends BaseType +class Zoo extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * Physical address of the item. + * + * @param PostalAddress|PostalAddress[]|string|string[] $address + * + * @return static + * + * @see http://schema.org/address + */ + public function address($address) + { + return $this->setProperty('address', $address); + } + + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * Upcoming or past event associated with this place, organization, or + * action. + * + * @param Event|Event[] $event + * + * @return static + * + * @see http://schema.org/event + */ + public function event($event) + { + return $this->setProperty('event', $event); + } + + /** + * Upcoming or past events associated with this place or organization. + * + * @param Event|Event[] $events + * + * @return static + * + * @see http://schema.org/events + */ + public function events($events) + { + return $this->setProperty('events', $events); + } + + /** + * The fax number. + * + * @param string|string[] $faxNumber + * + * @return static + * + * @see http://schema.org/faxNumber + */ + public function faxNumber($faxNumber) + { + return $this->setProperty('faxNumber', $faxNumber); + } + + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) + { + return $this->setProperty('globalLocationNumber', $globalLocationNumber); + } + + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + + /** + * A photograph of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * + * @return static + * + * @see http://schema.org/photo + */ + public function photo($photo) + { + return $this->setProperty('photo', $photo); + } + + /** + * Photographs of this place. + * + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * + * @return static + * + * @see http://schema.org/photos + */ + public function photos($photos) + { + return $this->setProperty('photos', $photos); + } + + /** + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value + * + * @param bool|bool[] $publicAccess + * + * @return static + * + * @see http://schema.org/publicAccess + */ + public function publicAccess($publicAccess) + { + return $this->setProperty('publicAccess', $publicAccess); + } + + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + + /** + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. + * + * @param bool|bool[] $smokingAllowed + * + * @return static + * + * @see http://schema.org/smokingAllowed + */ + public function smokingAllowed($smokingAllowed) + { + return $this->setProperty('smokingAllowed', $smokingAllowed); + } + + /** + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * + * @return static + * + * @see http://schema.org/specialOpeningHoursSpecification + */ + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + { + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + } + + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + } From a03eece642da25e165aeebab74ee06035264d176 Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 13:33:05 +0200 Subject: [PATCH 06/13] fix php cs --- generator/Type.php | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/generator/Type.php b/generator/Type.php index cc96e0029..83444ab34 100644 --- a/generator/Type.php +++ b/generator/Type.php @@ -44,20 +44,20 @@ public function addConstant(Constant $constant) public function setTypeCollection(TypeCollection $typeCollection): void { - if($this->parentProperties !== null) { + if ($this->parentProperties !== null) { return; } $this->parentProperties = []; - if(empty($this->parents)) { + if (empty($this->parents)) { return; } $types = $typeCollection->toArray(); - foreach($this->parents as $parent) { - if(!isset($types[$parent])) { + foreach ($this->parents as $parent) { + if (! isset($types[$parent])) { continue; } @@ -67,16 +67,16 @@ public function setTypeCollection(TypeCollection $typeCollection): void $this->grandParents = array_merge($parent->parents, $parent->grandParents); - foreach($parent->properties as $property) { - if(isset($this->parentProperties[$property->name])) { + foreach ($parent->properties as $property) { + if (isset($this->parentProperties[$property->name])) { continue; } $this->parentProperties[$property->name] = $property; } - foreach($parent->parentProperties as $parentProperty) { - if(isset($this->parentProperties[$parentProperty->name])) { + foreach ($parent->parentProperties as $parentProperty) { + if (isset($this->parentProperties[$parentProperty->name])) { continue; } From eaeee6f98c61bb0e89b1a3cb78d0789898d88daa Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 14:00:50 +0200 Subject: [PATCH 07/13] fix duplicated properties --- generator/Type.php | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/generator/Type.php b/generator/Type.php index 83444ab34..d7082ff55 100644 --- a/generator/Type.php +++ b/generator/Type.php @@ -19,9 +19,6 @@ class Type /** @var Property[] */ public $properties = []; - /** @var Property[] */ - public $parentProperties; - /** @var array */ public $constants = []; @@ -68,19 +65,11 @@ public function setTypeCollection(TypeCollection $typeCollection): void $this->grandParents = array_merge($parent->parents, $parent->grandParents); foreach ($parent->properties as $property) { - if (isset($this->parentProperties[$property->name])) { - continue; - } - - $this->parentProperties[$property->name] = $property; + $this->addProperty($property); } foreach ($parent->parentProperties as $parentProperty) { - if (isset($this->parentProperties[$parentProperty->name])) { - continue; - } - - $this->parentProperties[$parentProperty->name] = $parentProperty; + $this->addProperty($parentProperty); } } } From 311bb9b9c07e5c3fdbb825168b4c2be782f03174 Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 14:01:02 +0200 Subject: [PATCH 08/13] generated files --- src/AMRadioChannel.php | 150 +- src/APIReference.php | 870 ++++----- src/AboutPage.php | 726 ++++---- src/AcceptAction.php | 296 +-- src/Accommodation.php | 469 +++-- src/AccountingService.php | 1088 +++++------ src/AchieveAction.php | 296 +-- src/Action.php | 296 +-- src/ActionAccessSpecification.php | 128 +- src/ActivateAction.php | 296 +-- src/AddAction.php | 326 ++-- src/AdministrativeArea.php | 336 ++-- src/AdultEntertainment.php | 1076 +++++------ src/AggregateOffer.php | 512 +++--- src/AggregateRating.php | 216 +-- src/AgreeAction.php | 296 +-- src/Airline.php | 404 ++-- src/Airport.php | 450 ++--- src/AlignmentObject.php | 146 +- src/AllocateAction.php | 296 +-- src/AmusementPark.php | 1076 +++++------ src/AnimalShelter.php | 1076 +++++------ src/Answer.php | 456 ++--- src/Apartment.php | 515 +++--- src/ApartmentComplex.php | 336 ++-- src/AppendAction.php | 334 ++-- src/ApplyAction.php | 296 +-- src/Aquarium.php | 394 ++-- src/ArriveAction.php | 328 ++-- src/ArtGallery.php | 1076 +++++------ src/Article.php | 620 +++---- src/AskAction.php | 326 ++-- src/AssessAction.php | 296 +-- src/AssignAction.php | 296 +-- src/Attorney.php | 1076 +++++------ src/Audience.php | 58 +- src/AudioObject.php | 1004 +++++----- src/AuthorizeAction.php | 306 +-- src/AutoBodyShop.php | 1076 +++++------ src/AutoDealer.php | 1076 +++++------ src/AutoPartsStore.php | 1076 +++++------ src/AutoRental.php | 1076 +++++------ src/AutoRepair.php | 1076 +++++------ src/AutoWash.php | 1076 +++++------ src/AutomatedTeller.php | 1088 +++++------ src/AutomotiveBusiness.php | 1076 +++++------ src/Bakery.php | 1040 +++++------ src/BankAccount.php | 356 ++-- src/BankOrCreditUnion.php | 1088 +++++------ src/BarOrPub.php | 1040 +++++------ src/Barcode.php | 1058 +++++------ src/Beach.php | 394 ++-- src/BeautySalon.php | 1076 +++++------ src/BedAndBreakfast.php | 1078 +++++------ src/BedDetails.php | 60 +- src/BedType.php | 202 +- src/BefriendAction.php | 296 +-- src/BikeStore.php | 1076 +++++------ src/Blog.php | 460 ++--- src/BlogPosting.php | 670 +++---- src/BodyOfWater.php | 336 ++-- src/Book.php | 512 +++--- src/BookSeries.php | 496 ++--- src/BookStore.php | 1076 +++++------ src/BookmarkAction.php | 296 +-- src/BorrowAction.php | 322 ++-- src/BowlingAlley.php | 1076 +++++------ src/Brand.php | 114 +- src/BreadcrumbList.php | 110 +- src/Brewery.php | 1040 +++++------ src/Bridge.php | 394 ++-- src/BroadcastChannel.php | 150 +- src/BroadcastEvent.php | 578 +++--- src/BroadcastFrequencySpecification.php | 28 +- src/BroadcastService.php | 490 ++--- src/BuddhistTemple.php | 394 ++-- src/BusReservation.php | 320 ++-- src/BusStation.php | 394 ++-- src/BusStop.php | 394 ++-- src/BusTrip.php | 144 +- src/BusinessAudience.php | 142 +- src/BusinessEvent.php | 372 ++-- src/BuyAction.php | 418 ++--- src/CableOrSatelliteService.php | 316 ++-- src/CafeOrCoffeeShop.php | 1040 +++++------ src/Campground.php | 1126 ++++++------ src/CampingPitch.php | 480 ++--- src/Canal.php | 336 ++-- src/CancelAction.php | 304 +-- src/Car.php | 990 +++++----- src/Casino.php | 1076 +++++------ src/CatholicChurch.php | 394 ++-- src/Cemetery.php | 394 ++-- src/CheckAction.php | 296 +-- src/CheckInAction.php | 324 ++-- src/CheckOutAction.php | 324 ++-- src/CheckoutPage.php | 726 ++++---- src/ChildCare.php | 1076 +++++------ src/ChildrensEvent.php | 372 ++-- src/ChooseAction.php | 304 +-- src/Church.php | 394 ++-- src/City.php | 336 ++-- src/CityHall.php | 394 ++-- src/CivicStructure.php | 394 ++-- src/ClaimReview.php | 532 +++--- src/Clip.php | 678 +++---- src/ClothingStore.php | 1076 +++++------ src/Code.php | 372 ++-- src/CollectionPage.php | 726 ++++---- src/CollegeOrUniversity.php | 374 ++-- src/ComedyClub.php | 1076 +++++------ src/ComedyEvent.php | 372 ++-- src/Comment.php | 456 ++--- src/CommentAction.php | 328 ++-- src/CommunicateAction.php | 324 ++-- src/CompoundPriceSpecification.php | 336 ++-- src/ComputerStore.php | 1076 +++++------ src/ConfirmAction.php | 328 ++-- src/ConsumeAction.php | 308 ++-- src/ContactPage.php | 726 ++++---- src/ContactPoint.php | 212 +-- src/Continent.php | 336 ++-- src/Contracts/AMRadioChannelContract.php | 20 +- src/Contracts/APIReferenceContract.php | 104 +- src/Contracts/AboutPageContract.php | 88 +- src/Contracts/AcceptActionContract.php | 40 +- src/Contracts/AccommodationContract.php | 62 +- src/Contracts/AccountingServiceContract.php | 146 +- src/Contracts/AchieveActionContract.php | 40 +- .../ActionAccessSpecificationContract.php | 20 +- src/Contracts/ActionContract.php | 40 +- src/Contracts/ActivateActionContract.php | 40 +- src/Contracts/AddActionContract.php | 48 +- src/Contracts/AdministrativeAreaContract.php | 44 +- src/Contracts/AdultEntertainmentContract.php | 142 +- src/Contracts/AggregateOfferContract.php | 64 +- src/Contracts/AggregateRatingContract.php | 28 +- src/Contracts/AgreeActionContract.php | 40 +- src/Contracts/AirlineContract.php | 54 +- src/Contracts/AirportContract.php | 56 +- src/Contracts/AlignmentObjectContract.php | 20 +- src/Contracts/AllocateActionContract.php | 40 +- src/Contracts/AmusementParkContract.php | 142 +- src/Contracts/AnimalShelterContract.php | 142 +- src/Contracts/AnswerContract.php | 60 +- src/Contracts/ApartmentComplexContract.php | 44 +- src/Contracts/ApartmentContract.php | 70 +- src/Contracts/AppendActionContract.php | 50 +- src/Contracts/ApplyActionContract.php | 40 +- src/Contracts/AquariumContract.php | 48 +- src/Contracts/ArriveActionContract.php | 48 +- src/Contracts/ArtGalleryContract.php | 142 +- src/Contracts/ArticleContract.php | 76 +- src/Contracts/AskActionContract.php | 50 +- src/Contracts/AssessActionContract.php | 40 +- src/Contracts/AssignActionContract.php | 40 +- src/Contracts/AttorneyContract.php | 142 +- src/Contracts/AudienceContract.php | 8 +- src/Contracts/AudioObjectContract.php | 124 +- src/Contracts/AuthorizeActionContract.php | 44 +- src/Contracts/AutoBodyShopContract.php | 142 +- src/Contracts/AutoDealerContract.php | 142 +- src/Contracts/AutoPartsStoreContract.php | 142 +- src/Contracts/AutoRentalContract.php | 142 +- src/Contracts/AutoRepairContract.php | 142 +- src/Contracts/AutoWashContract.php | 142 +- src/Contracts/AutomatedTellerContract.php | 146 +- src/Contracts/AutomotiveBusinessContract.php | 142 +- src/Contracts/BakeryContract.php | 154 +- src/Contracts/BankAccountContract.php | 48 +- src/Contracts/BankOrCreditUnionContract.php | 146 +- src/Contracts/BarOrPubContract.php | 154 +- src/Contracts/BarcodeContract.php | 132 +- src/Contracts/BeachContract.php | 48 +- src/Contracts/BeautySalonContract.php | 142 +- src/Contracts/BedAndBreakfastContract.php | 160 +- src/Contracts/BedDetailsContract.php | 8 +- src/Contracts/BedTypeContract.php | 28 +- src/Contracts/BefriendActionContract.php | 40 +- src/Contracts/BikeStoreContract.php | 142 +- src/Contracts/BlogContract.php | 60 +- src/Contracts/BlogPostingContract.php | 80 +- src/Contracts/BodyOfWaterContract.php | 44 +- src/Contracts/BookContract.php | 68 +- src/Contracts/BookSeriesContract.php | 64 +- src/Contracts/BookStoreContract.php | 142 +- src/Contracts/BookmarkActionContract.php | 40 +- src/Contracts/BorrowActionContract.php | 48 +- src/Contracts/BowlingAlleyContract.php | 142 +- src/Contracts/BrandContract.php | 16 +- src/Contracts/BreadcrumbListContract.php | 12 +- src/Contracts/BreweryContract.php | 154 +- src/Contracts/BridgeContract.php | 48 +- src/Contracts/BroadcastChannelContract.php | 20 +- src/Contracts/BroadcastEventContract.php | 72 +- ...roadcastFrequencySpecificationContract.php | 4 +- src/Contracts/BroadcastServiceContract.php | 72 +- src/Contracts/BuddhistTempleContract.php | 48 +- src/Contracts/BusReservationContract.php | 44 +- src/Contracts/BusStationContract.php | 48 +- src/Contracts/BusStopContract.php | 48 +- src/Contracts/BusTripContract.php | 20 +- src/Contracts/BusinessAudienceContract.php | 20 +- src/Contracts/BusinessEventContract.php | 48 +- src/Contracts/BuyActionContract.php | 54 +- .../CableOrSatelliteServiceContract.php | 40 +- src/Contracts/CafeOrCoffeeShopContract.php | 154 +- src/Contracts/CampgroundContract.php | 182 +- src/Contracts/CampingPitchContract.php | 64 +- src/Contracts/CanalContract.php | 44 +- src/Contracts/CancelActionContract.php | 44 +- src/Contracts/CarContract.php | 126 +- src/Contracts/CasinoContract.php | 142 +- src/Contracts/CatholicChurchContract.php | 48 +- src/Contracts/CemeteryContract.php | 48 +- src/Contracts/CheckActionContract.php | 40 +- src/Contracts/CheckInActionContract.php | 48 +- src/Contracts/CheckOutActionContract.php | 48 +- src/Contracts/CheckoutPageContract.php | 88 +- src/Contracts/ChildCareContract.php | 142 +- src/Contracts/ChildrensEventContract.php | 48 +- src/Contracts/ChooseActionContract.php | 44 +- src/Contracts/ChurchContract.php | 48 +- src/Contracts/CityContract.php | 44 +- src/Contracts/CityHallContract.php | 48 +- src/Contracts/CivicStructureContract.php | 48 +- src/Contracts/ClaimReviewContract.php | 68 +- src/Contracts/ClipContract.php | 84 +- src/Contracts/ClothingStoreContract.php | 142 +- src/Contracts/CodeContract.php | 48 +- src/Contracts/CollectionPageContract.php | 88 +- src/Contracts/CollegeOrUniversityContract.php | 50 +- src/Contracts/ComedyClubContract.php | 142 +- src/Contracts/ComedyEventContract.php | 48 +- src/Contracts/CommentActionContract.php | 50 +- src/Contracts/CommentContract.php | 60 +- src/Contracts/CommunicateActionContract.php | 48 +- .../CompoundPriceSpecificationContract.php | 40 +- src/Contracts/ComputerStoreContract.php | 142 +- src/Contracts/ConfirmActionContract.php | 50 +- src/Contracts/ConsumeActionContract.php | 44 +- src/Contracts/ContactPageContract.php | 88 +- src/Contracts/ContactPointContract.php | 28 +- src/Contracts/ContinentContract.php | 44 +- src/Contracts/ControlActionContract.php | 40 +- src/Contracts/ConvenienceStoreContract.php | 142 +- src/Contracts/ConversationContract.php | 48 +- src/Contracts/CookActionContract.php | 48 +- src/Contracts/CorporationContract.php | 48 +- src/Contracts/CountryContract.php | 44 +- src/Contracts/CourseContract.php | 60 +- src/Contracts/CourseInstanceContract.php | 56 +- src/Contracts/CourthouseContract.php | 48 +- src/Contracts/CreateActionContract.php | 40 +- src/Contracts/CreativeWorkContract.php | 48 +- src/Contracts/CreativeWorkSeasonContract.php | 92 +- src/Contracts/CreativeWorkSeriesContract.php | 64 +- src/Contracts/CreditCardContract.php | 60 +- src/Contracts/CrematoriumContract.php | 48 +- .../CurrencyConversionServiceContract.php | 48 +- src/Contracts/DanceEventContract.php | 48 +- src/Contracts/DanceGroupContract.php | 48 +- src/Contracts/DataCatalogContract.php | 52 +- src/Contracts/DataDownloadContract.php | 116 +- src/Contracts/DataFeedContract.php | 76 +- src/Contracts/DataFeedItemContract.php | 12 +- src/Contracts/DatasetContract.php | 72 +- .../DatedMoneySpecificationContract.php | 8 +- src/Contracts/DaySpaContract.php | 142 +- src/Contracts/DeactivateActionContract.php | 40 +- .../DefenceEstablishmentContract.php | 48 +- src/Contracts/DeleteActionContract.php | 48 +- .../DeliveryChargeSpecificationContract.php | 48 +- src/Contracts/DeliveryEventContract.php | 64 +- src/Contracts/DemandContract.php | 48 +- src/Contracts/DentistContract.php | 144 +- src/Contracts/DepartActionContract.php | 48 +- src/Contracts/DepartmentStoreContract.php | 142 +- src/Contracts/DepositAccountContract.php | 52 +- src/Contracts/DigitalDocumentContract.php | 52 +- .../DigitalDocumentPermissionContract.php | 8 +- src/Contracts/DisagreeActionContract.php | 40 +- src/Contracts/DiscoverActionContract.php | 40 +- .../DiscussionForumPostingContract.php | 80 +- src/Contracts/DislikeActionContract.php | 40 +- src/Contracts/DistilleryContract.php | 154 +- src/Contracts/DonateActionContract.php | 48 +- src/Contracts/DownloadActionContract.php | 48 +- src/Contracts/DrawActionContract.php | 40 +- src/Contracts/DrinkActionContract.php | 44 +- .../DriveWheelConfigurationValueContract.php | 28 +- .../DryCleaningOrLaundryContract.php | 142 +- src/Contracts/EatActionContract.php | 44 +- src/Contracts/EducationEventContract.php | 48 +- src/Contracts/EducationalAudienceContract.php | 12 +- .../EducationalOrganizationContract.php | 50 +- src/Contracts/ElectricianContract.php | 142 +- src/Contracts/ElectronicsStoreContract.php | 142 +- src/Contracts/ElementarySchoolContract.php | 50 +- src/Contracts/EmailMessageContract.php | 84 +- src/Contracts/EmbassyContract.php | 48 +- src/Contracts/EmergencyServiceContract.php | 142 +- src/Contracts/EmployeeRoleContract.php | 28 +- .../EmployerAggregateRatingContract.php | 28 +- src/Contracts/EmploymentAgencyContract.php | 142 +- src/Contracts/EndorseActionContract.php | 44 +- src/Contracts/EndorsementRatingContract.php | 20 +- src/Contracts/EngineSpecificationContract.php | 4 +- .../EntertainmentBusinessContract.php | 142 +- src/Contracts/EntryPointContract.php | 20 +- src/Contracts/EpisodeContract.php | 88 +- src/Contracts/EventContract.php | 48 +- src/Contracts/EventReservationContract.php | 44 +- src/Contracts/EventVenueContract.php | 48 +- src/Contracts/ExerciseActionContract.php | 62 +- src/Contracts/ExerciseGymContract.php | 142 +- src/Contracts/ExhibitionEventContract.php | 48 +- src/Contracts/FAQPageContract.php | 88 +- src/Contracts/FMRadioChannelContract.php | 20 +- src/Contracts/FastFoodRestaurantContract.php | 154 +- src/Contracts/FestivalContract.php | 48 +- src/Contracts/FilmActionContract.php | 40 +- src/Contracts/FinancialProductContract.php | 48 +- src/Contracts/FinancialServiceContract.php | 146 +- src/Contracts/FindActionContract.php | 40 +- src/Contracts/FireStationContract.php | 166 +- src/Contracts/FlightContract.php | 42 +- src/Contracts/FlightReservationContract.php | 50 +- src/Contracts/FloristContract.php | 142 +- src/Contracts/FollowActionContract.php | 44 +- src/Contracts/FoodEstablishmentContract.php | 154 +- .../FoodEstablishmentReservationContract.php | 50 +- src/Contracts/FoodEventContract.php | 48 +- src/Contracts/FoodServiceContract.php | 40 +- src/Contracts/FurnitureStoreContract.php | 142 +- src/Contracts/GameContract.php | 68 +- src/Contracts/GameServerContract.php | 12 +- src/Contracts/GardenStoreContract.php | 142 +- src/Contracts/GasStationContract.php | 142 +- .../GatedResidenceCommunityContract.php | 44 +- src/Contracts/GeneralContractorContract.php | 142 +- src/Contracts/GeoCircleContract.php | 28 +- src/Contracts/GeoCoordinatesContract.php | 20 +- src/Contracts/GeoShapeContract.php | 28 +- src/Contracts/GiveActionContract.php | 48 +- src/Contracts/GolfCourseContract.php | 142 +- src/Contracts/GovernmentBuildingContract.php | 48 +- src/Contracts/GovernmentOfficeContract.php | 142 +- .../GovernmentOrganizationContract.php | 48 +- src/Contracts/GovernmentPermitContract.php | 28 +- src/Contracts/GovernmentServiceContract.php | 42 +- src/Contracts/GroceryStoreContract.php | 142 +- src/Contracts/HVACBusinessContract.php | 142 +- src/Contracts/HairSalonContract.php | 142 +- src/Contracts/HardwareStoreContract.php | 142 +- .../HealthAndBeautyBusinessContract.php | 142 +- src/Contracts/HealthClubContract.php | 142 +- src/Contracts/HighSchoolContract.php | 50 +- src/Contracts/HinduTempleContract.php | 48 +- src/Contracts/HobbyShopContract.php | 142 +- .../HomeAndConstructionBusinessContract.php | 142 +- src/Contracts/HomeGoodsStoreContract.php | 142 +- src/Contracts/HospitalContract.php | 166 +- src/Contracts/HostelContract.php | 160 +- src/Contracts/HotelContract.php | 160 +- src/Contracts/HotelRoomContract.php | 70 +- src/Contracts/HouseContract.php | 66 +- src/Contracts/HousePainterContract.php | 142 +- src/Contracts/HowToContract.php | 82 +- src/Contracts/HowToDirectionContract.php | 96 +- src/Contracts/HowToItemContract.php | 20 +- src/Contracts/HowToSectionContract.php | 80 +- src/Contracts/HowToStepContract.php | 76 +- src/Contracts/HowToSupplyContract.php | 24 +- src/Contracts/HowToTipContract.php | 64 +- src/Contracts/HowToToolContract.php | 20 +- src/Contracts/IceCreamShopContract.php | 154 +- src/Contracts/IgnoreActionContract.php | 40 +- src/Contracts/ImageGalleryContract.php | 88 +- src/Contracts/ImageObjectContract.php | 132 +- src/Contracts/IndividualProductContract.php | 52 +- src/Contracts/InformActionContract.php | 50 +- src/Contracts/InsertActionContract.php | 50 +- src/Contracts/InstallActionContract.php | 44 +- src/Contracts/InsuranceAgencyContract.php | 146 +- src/Contracts/InteractActionContract.php | 40 +- src/Contracts/InteractionCounterContract.php | 4 +- src/Contracts/InternetCafeContract.php | 142 +- src/Contracts/InvestmentOrDepositContract.php | 50 +- src/Contracts/InviteActionContract.php | 50 +- src/Contracts/InvoiceContract.php | 44 +- src/Contracts/ItemListContract.php | 12 +- src/Contracts/ItemPageContract.php | 88 +- src/Contracts/JewelryStoreContract.php | 142 +- src/Contracts/JobPostingContract.php | 48 +- src/Contracts/JoinActionContract.php | 44 +- src/Contracts/LakeBodyOfWaterContract.php | 44 +- src/Contracts/LandformContract.php | 44 +- ...LandmarksOrHistoricalBuildingsContract.php | 44 +- src/Contracts/LeaveActionContract.php | 44 +- src/Contracts/LegalServiceContract.php | 142 +- src/Contracts/LegislativeBuildingContract.php | 48 +- src/Contracts/LendActionContract.php | 50 +- src/Contracts/LibraryContract.php | 142 +- src/Contracts/LikeActionContract.php | 40 +- src/Contracts/LiquorStoreContract.php | 142 +- src/Contracts/ListItemContract.php | 16 +- src/Contracts/ListenActionContract.php | 44 +- src/Contracts/LiteraryEventContract.php | 48 +- src/Contracts/LiveBlogPostingContract.php | 92 +- src/Contracts/LoanOrCreditContract.php | 58 +- src/Contracts/LocalBusinessContract.php | 142 +- .../LocationFeatureSpecificationContract.php | 40 +- src/Contracts/LocksmithContract.php | 142 +- src/Contracts/LodgingBusinessContract.php | 162 +- src/Contracts/LodgingReservationContract.php | 56 +- src/Contracts/LoseActionContract.php | 44 +- src/Contracts/MapContract.php | 52 +- src/Contracts/MarryActionContract.php | 40 +- src/Contracts/MediaObjectContract.php | 114 +- src/Contracts/MediaSubscriptionContract.php | 8 +- src/Contracts/MedicalOrganizationContract.php | 48 +- src/Contracts/MeetingRoomContract.php | 64 +- src/Contracts/MensClothingStoreContract.php | 142 +- src/Contracts/MenuContract.php | 56 +- src/Contracts/MenuItemContract.php | 62 +- src/Contracts/MenuSectionContract.php | 56 +- src/Contracts/MessageContract.php | 84 +- src/Contracts/MiddleSchoolContract.php | 50 +- src/Contracts/MobileApplicationContract.php | 148 +- src/Contracts/MobilePhoneStoreContract.php | 142 +- src/Contracts/MonetaryAmountContract.php | 16 +- .../MonetaryAmountDistributionContract.php | 24 +- src/Contracts/MosqueContract.php | 48 +- src/Contracts/MotelContract.php | 160 +- src/Contracts/MotorcycleDealerContract.php | 142 +- src/Contracts/MotorcycleRepairContract.php | 142 +- src/Contracts/MountainContract.php | 44 +- src/Contracts/MoveActionContract.php | 48 +- src/Contracts/MovieClipContract.php | 84 +- src/Contracts/MovieContract.php | 88 +- src/Contracts/MovieRentalStoreContract.php | 142 +- src/Contracts/MovieSeriesContract.php | 88 +- src/Contracts/MovieTheaterContract.php | 168 +- src/Contracts/MovingCompanyContract.php | 142 +- src/Contracts/MuseumContract.php | 48 +- src/Contracts/MusicAlbumContract.php | 76 +- src/Contracts/MusicCompositionContract.php | 88 +- src/Contracts/MusicEventContract.php | 48 +- src/Contracts/MusicGroupContract.php | 64 +- src/Contracts/MusicPlaylistContract.php | 60 +- src/Contracts/MusicRecordingContract.php | 72 +- src/Contracts/MusicReleaseContract.php | 80 +- src/Contracts/MusicStoreContract.php | 142 +- src/Contracts/MusicVenueContract.php | 48 +- src/Contracts/MusicVideoObjectContract.php | 116 +- src/Contracts/NGOContract.php | 48 +- src/Contracts/NailSalonContract.php | 142 +- src/Contracts/NewsArticleContract.php | 96 +- src/Contracts/NightClubContract.php | 142 +- src/Contracts/NotaryContract.php | 142 +- src/Contracts/NoteDigitalDocumentContract.php | 52 +- .../NutritionInformationContract.php | 44 +- src/Contracts/OccupationContract.php | 32 +- src/Contracts/OceanBodyOfWaterContract.php | 44 +- src/Contracts/OfferCatalogContract.php | 12 +- src/Contracts/OfferContract.php | 48 +- .../OfficeEquipmentStoreContract.php | 142 +- src/Contracts/OnDemandEventContract.php | 60 +- .../OpeningHoursSpecificationContract.php | 20 +- src/Contracts/OrderActionContract.php | 50 +- src/Contracts/OrderContract.php | 36 +- src/Contracts/OrderItemContract.php | 20 +- src/Contracts/OrganizationContract.php | 48 +- src/Contracts/OrganizationRoleContract.php | 20 +- src/Contracts/OrganizeActionContract.php | 40 +- src/Contracts/OutletStoreContract.php | 142 +- src/Contracts/OwnershipInfoContract.php | 12 +- src/Contracts/PaintActionContract.php | 40 +- src/Contracts/PaintingContract.php | 48 +- src/Contracts/ParcelDeliveryContract.php | 40 +- src/Contracts/ParentAudienceContract.php | 36 +- src/Contracts/ParkContract.php | 48 +- src/Contracts/ParkingFacilityContract.php | 48 +- src/Contracts/PawnShopContract.php | 142 +- src/Contracts/PayActionContract.php | 48 +- src/Contracts/PaymentCardContract.php | 48 +- .../PaymentChargeSpecificationContract.php | 44 +- src/Contracts/PaymentServiceContract.php | 48 +- src/Contracts/PeopleAudienceContract.php | 32 +- src/Contracts/PerformActionContract.php | 48 +- src/Contracts/PerformanceRoleContract.php | 20 +- .../PerformingArtsTheaterContract.php | 48 +- src/Contracts/PerformingGroupContract.php | 48 +- src/Contracts/PeriodicalContract.php | 64 +- src/Contracts/PermitContract.php | 28 +- src/Contracts/PersonContract.php | 48 +- src/Contracts/PetStoreContract.php | 142 +- src/Contracts/PharmacyContract.php | 48 +- src/Contracts/PhotographActionContract.php | 40 +- src/Contracts/PhotographContract.php | 48 +- src/Contracts/PhysicianContract.php | 48 +- src/Contracts/PlaceContract.php | 44 +- src/Contracts/PlaceOfWorshipContract.php | 48 +- src/Contracts/PlanActionContract.php | 44 +- src/Contracts/PlayActionContract.php | 46 +- src/Contracts/PlaygroundContract.php | 48 +- src/Contracts/PlumberContract.php | 142 +- src/Contracts/PoliceStationContract.php | 166 +- src/Contracts/PondContract.php | 44 +- src/Contracts/PostOfficeContract.php | 142 +- src/Contracts/PostalAddressContract.php | 38 +- src/Contracts/PreOrderActionContract.php | 48 +- src/Contracts/PrependActionContract.php | 50 +- src/Contracts/PreschoolContract.php | 50 +- .../PresentationDigitalDocumentContract.php | 52 +- src/Contracts/PriceSpecificationContract.php | 36 +- src/Contracts/ProductContract.php | 48 +- src/Contracts/ProductModelContract.php | 58 +- src/Contracts/ProfessionalServiceContract.php | 142 +- src/Contracts/ProfilePageContract.php | 88 +- src/Contracts/ProgramMembershipContract.php | 20 +- src/Contracts/PropertyValueContract.php | 28 +- .../PropertyValueSpecificationContract.php | 44 +- src/Contracts/PublicSwimmingPoolContract.php | 142 +- src/Contracts/PublicationEventContract.php | 58 +- src/Contracts/PublicationIssueContract.php | 64 +- src/Contracts/PublicationVolumeContract.php | 64 +- src/Contracts/QAPageContract.php | 88 +- src/Contracts/QualitativeValueContract.php | 28 +- src/Contracts/QuantitativeValueContract.php | 24 +- .../QuantitativeValueDistributionContract.php | 20 +- src/Contracts/QuestionContract.php | 68 +- src/Contracts/QuoteActionContract.php | 48 +- src/Contracts/RVParkContract.php | 48 +- src/Contracts/RadioChannelContract.php | 20 +- src/Contracts/RadioClipContract.php | 84 +- src/Contracts/RadioEpisodeContract.php | 88 +- src/Contracts/RadioSeasonContract.php | 92 +- src/Contracts/RadioSeriesContract.php | 118 +- src/Contracts/RadioStationContract.php | 142 +- src/Contracts/RatingContract.php | 20 +- src/Contracts/ReactActionContract.php | 40 +- src/Contracts/ReadActionContract.php | 44 +- src/Contracts/RealEstateAgentContract.php | 142 +- src/Contracts/ReceiveActionContract.php | 50 +- src/Contracts/RecipeContract.php | 122 +- src/Contracts/RecyclingCenterContract.php | 142 +- src/Contracts/RegisterActionContract.php | 40 +- src/Contracts/RejectActionContract.php | 40 +- src/Contracts/RentActionContract.php | 50 +- .../RentalCarReservationContract.php | 50 +- src/Contracts/ReplaceActionContract.php | 50 +- src/Contracts/ReplyActionContract.php | 50 +- src/Contracts/ReportContract.php | 80 +- src/Contracts/ReservationContract.php | 44 +- src/Contracts/ReservationPackageContract.php | 46 +- src/Contracts/ReserveActionContract.php | 44 +- src/Contracts/ReservoirContract.php | 44 +- src/Contracts/ResidenceContract.php | 44 +- src/Contracts/ResortContract.php | 160 +- src/Contracts/RestaurantContract.php | 154 +- src/Contracts/ResumeActionContract.php | 40 +- src/Contracts/ReturnActionContract.php | 48 +- src/Contracts/ReviewActionContract.php | 44 +- src/Contracts/ReviewContract.php | 64 +- src/Contracts/RiverBodyOfWaterContract.php | 44 +- src/Contracts/RoleContract.php | 16 +- src/Contracts/RoofingContractorContract.php | 142 +- src/Contracts/RoomContract.php | 64 +- src/Contracts/RsvpActionContract.php | 56 +- src/Contracts/SaleEventContract.php | 48 +- src/Contracts/ScheduleActionContract.php | 44 +- src/Contracts/ScholarlyArticleContract.php | 76 +- src/Contracts/SchoolContract.php | 50 +- src/Contracts/ScreeningEventContract.php | 58 +- src/Contracts/SculptureContract.php | 48 +- src/Contracts/SeaBodyOfWaterContract.php | 44 +- src/Contracts/SearchActionContract.php | 44 +- src/Contracts/SearchResultsPageContract.php | 88 +- src/Contracts/SeasonContract.php | 48 +- src/Contracts/SeatContract.php | 16 +- src/Contracts/SelfStorageContract.php | 142 +- src/Contracts/SellActionContract.php | 52 +- src/Contracts/SendActionContract.php | 50 +- src/Contracts/SeriesContract.php | 4 +- src/Contracts/ServiceChannelContract.php | 32 +- src/Contracts/ServiceContract.php | 40 +- src/Contracts/ShareActionContract.php | 48 +- src/Contracts/ShoeStoreContract.php | 142 +- src/Contracts/ShoppingCenterContract.php | 142 +- .../SingleFamilyResidenceContract.php | 70 +- .../SiteNavigationElementContract.php | 48 +- src/Contracts/SkiResortContract.php | 142 +- src/Contracts/SocialEventContract.php | 48 +- src/Contracts/SocialMediaPostingContract.php | 80 +- src/Contracts/SoftwareApplicationContract.php | 144 +- src/Contracts/SoftwareSourceCodeContract.php | 76 +- src/Contracts/SomeProductsContract.php | 52 +- src/Contracts/SportingGoodsStoreContract.php | 142 +- .../SportsActivityLocationContract.php | 142 +- src/Contracts/SportsClubContract.php | 142 +- src/Contracts/SportsEventContract.php | 60 +- src/Contracts/SportsOrganizationContract.php | 50 +- src/Contracts/SportsTeamContract.php | 58 +- .../SpreadsheetDigitalDocumentContract.php | 52 +- src/Contracts/StadiumOrArenaContract.php | 166 +- src/Contracts/StateContract.php | 44 +- .../SteeringPositionValueContract.php | 28 +- src/Contracts/StoreContract.php | 142 +- src/Contracts/SubscribeActionContract.php | 40 +- src/Contracts/SubwayStationContract.php | 48 +- src/Contracts/SuiteContract.php | 72 +- src/Contracts/SuspendActionContract.php | 40 +- src/Contracts/SynagogueContract.php | 48 +- src/Contracts/TVClipContract.php | 88 +- src/Contracts/TVEpisodeContract.php | 100 +- src/Contracts/TVSeasonContract.php | 100 +- src/Contracts/TVSeriesContract.php | 122 +- src/Contracts/TableContract.php | 48 +- src/Contracts/TakeActionContract.php | 48 +- src/Contracts/TattooParlorContract.php | 142 +- src/Contracts/TaxiContract.php | 40 +- src/Contracts/TaxiReservationContract.php | 48 +- src/Contracts/TaxiServiceContract.php | 40 +- src/Contracts/TaxiStandContract.php | 48 +- src/Contracts/TechArticleContract.php | 84 +- src/Contracts/TelevisionChannelContract.php | 20 +- src/Contracts/TelevisionStationContract.php | 142 +- src/Contracts/TennisComplexContract.php | 142 +- src/Contracts/TextDigitalDocumentContract.php | 52 +- src/Contracts/TheaterEventContract.php | 48 +- src/Contracts/TheaterGroupContract.php | 48 +- src/Contracts/TicketContract.php | 32 +- src/Contracts/TieActionContract.php | 40 +- src/Contracts/TipActionContract.php | 48 +- src/Contracts/TireShopContract.php | 142 +- src/Contracts/TouristAttractionContract.php | 50 +- .../TouristInformationCenterContract.php | 142 +- src/Contracts/ToyStoreContract.php | 142 +- src/Contracts/TrackActionContract.php | 44 +- src/Contracts/TradeActionContract.php | 48 +- src/Contracts/TrainReservationContract.php | 44 +- src/Contracts/TrainStationContract.php | 48 +- src/Contracts/TrainTripContract.php | 28 +- src/Contracts/TransferActionContract.php | 48 +- src/Contracts/TravelActionContract.php | 50 +- src/Contracts/TravelAgencyContract.php | 142 +- src/Contracts/TripContract.php | 16 +- src/Contracts/TypeAndQuantityNodeContract.php | 20 +- src/Contracts/UnRegisterActionContract.php | 40 +- .../UnitPriceSpecificationContract.php | 48 +- src/Contracts/UpdateActionContract.php | 48 +- src/Contracts/UseActionContract.php | 44 +- src/Contracts/UserBlocksContract.php | 48 +- src/Contracts/UserCheckinsContract.php | 48 +- src/Contracts/UserCommentsContract.php | 68 +- src/Contracts/UserDownloadsContract.php | 48 +- src/Contracts/UserInteractionContract.php | 48 +- src/Contracts/UserLikesContract.php | 48 +- src/Contracts/UserPageVisitsContract.php | 48 +- src/Contracts/UserPlaysContract.php | 48 +- src/Contracts/UserPlusOnesContract.php | 48 +- src/Contracts/UserTweetsContract.php | 48 +- src/Contracts/VehicleContract.php | 122 +- src/Contracts/VideoGalleryContract.php | 88 +- src/Contracts/VideoGameClipContract.php | 84 +- src/Contracts/VideoGameContract.php | 208 +-- src/Contracts/VideoGameSeriesContract.php | 150 +- src/Contracts/VideoObjectContract.php | 152 +- src/Contracts/ViewActionContract.php | 44 +- src/Contracts/VisualArtsEventContract.php | 48 +- src/Contracts/VisualArtworkContract.php | 68 +- src/Contracts/VolcanoContract.php | 44 +- src/Contracts/VoteActionContract.php | 46 +- src/Contracts/WPAdBlockContract.php | 48 +- src/Contracts/WPFooterContract.php | 48 +- src/Contracts/WPHeaderContract.php | 48 +- src/Contracts/WPSideBarContract.php | 48 +- src/Contracts/WantActionContract.php | 40 +- src/Contracts/WarrantyPromiseContract.php | 8 +- src/Contracts/WatchActionContract.php | 44 +- src/Contracts/WaterfallContract.php | 44 +- src/Contracts/WearActionContract.php | 44 +- src/Contracts/WebApplicationContract.php | 148 +- src/Contracts/WebPageContract.php | 88 +- src/Contracts/WebPageElementContract.php | 48 +- src/Contracts/WebSiteContract.php | 52 +- src/Contracts/WholesaleStoreContract.php | 142 +- src/Contracts/WinActionContract.php | 44 +- src/Contracts/WineryContract.php | 154 +- src/Contracts/WorkersUnionContract.php | 48 +- src/Contracts/WriteActionContract.php | 46 +- src/Contracts/ZooContract.php | 48 +- src/ControlAction.php | 296 +-- src/ConvenienceStore.php | 1076 +++++------ src/Conversation.php | 372 ++-- src/CookAction.php | 322 ++-- src/Corporation.php | 364 ++-- src/Country.php | 336 ++-- src/Course.php | 466 ++--- src/CourseInstance.php | 438 ++--- src/Courthouse.php | 394 ++-- src/CreateAction.php | 296 +-- src/CreativeWork.php | 372 ++-- src/CreativeWorkSeason.php | 736 ++++---- src/CreativeWorkSeries.php | 496 ++--- src/CreditCard.php | 426 ++--- src/Crematorium.php | 394 ++-- src/CurrencyConversionService.php | 356 ++-- src/DanceEvent.php | 372 ++-- src/DanceGroup.php | 364 ++-- src/DataCatalog.php | 400 ++-- src/DataDownload.php | 924 +++++----- src/DataFeed.php | 610 +++--- src/DataFeedItem.php | 94 +- src/Dataset.php | 608 +++--- src/DatedMoneySpecification.php | 66 +- src/DaySpa.php | 1076 +++++------ src/DeactivateAction.php | 296 +-- src/DefenceEstablishment.php | 394 ++-- src/DeleteAction.php | 326 ++-- src/DeliveryChargeSpecification.php | 382 ++-- src/DeliveryEvent.php | 466 ++--- src/Demand.php | 358 ++-- src/Dentist.php | 1126 ++++++------ src/DepartAction.php | 328 ++-- src/DepartmentStore.php | 1076 +++++------ src/DepositAccount.php | 384 ++-- src/DigitalDocument.php | 404 ++-- src/DigitalDocumentPermission.php | 58 +- src/DisagreeAction.php | 296 +-- src/DiscoverAction.php | 296 +-- src/DiscussionForumPosting.php | 670 +++---- src/DislikeAction.php | 296 +-- src/Distillery.php | 1040 +++++------ src/DonateAction.php | 376 ++-- src/DownloadAction.php | 328 ++-- src/DrawAction.php | 296 +-- src/DrinkAction.php | 308 ++-- src/DriveWheelConfigurationValue.php | 202 +- src/DryCleaningOrLaundry.php | 1076 +++++------ src/EatAction.php | 308 ++-- src/EducationEvent.php | 372 ++-- src/EducationalAudience.php | 86 +- src/EducationalOrganization.php | 374 ++-- src/Electrician.php | 1076 +++++------ src/ElectronicsStore.php | 1076 +++++------ src/ElementarySchool.php | 374 ++-- src/EmailMessage.php | 704 +++---- src/Embassy.php | 394 ++-- src/EmergencyService.php | 1076 +++++------ src/EmployeeRole.php | 216 +-- src/EmployerAggregateRating.php | 216 +-- src/EmploymentAgency.php | 1076 +++++------ src/EndorseAction.php | 304 +-- src/EndorsementRating.php | 158 +- src/EngineSpecification.php | 32 +- src/EntertainmentBusiness.php | 1076 +++++------ src/EntryPoint.php | 128 +- src/Episode.php | 706 +++---- src/Event.php | 372 ++-- src/EventReservation.php | 320 ++-- src/EventVenue.php | 394 ++-- src/ExerciseAction.php | 408 ++-- src/ExerciseGym.php | 1076 +++++------ src/ExhibitionEvent.php | 372 ++-- src/FAQPage.php | 726 ++++---- src/FMRadioChannel.php | 150 +- src/FastFoodRestaurant.php | 1040 +++++------ src/Festival.php | 372 ++-- src/FilmAction.php | 296 +-- src/FinancialProduct.php | 356 ++-- src/FinancialService.php | 1088 +++++------ src/FindAction.php | 296 +-- src/FireStation.php | 1040 +++++------ src/Flight.php | 304 +-- src/FlightReservation.php | 336 ++-- src/Florist.php | 1076 +++++------ src/FollowAction.php | 304 +-- src/FoodEstablishment.php | 1040 +++++------ src/FoodEstablishmentReservation.php | 368 ++-- src/FoodEvent.php | 372 ++-- src/FoodService.php | 316 ++-- src/FurnitureStore.php | 1076 +++++------ src/Game.php | 550 +++--- src/GameServer.php | 84 +- src/GardenStore.php | 1076 +++++------ src/GasStation.php | 1076 +++++------ src/GatedResidenceCommunity.php | 336 ++-- src/GeneralContractor.php | 1076 +++++------ src/GeoCircle.php | 204 +- src/GeoCoordinates.php | 160 +- src/GeoShape.php | 210 +-- src/GiveAction.php | 322 ++-- src/GolfCourse.php | 1076 +++++------ src/GovernmentBuilding.php | 394 ++-- src/GovernmentOffice.php | 1076 +++++------ src/GovernmentOrganization.php | 364 ++-- src/GovernmentPermit.php | 196 +- src/GovernmentService.php | 330 ++-- src/GroceryStore.php | 1076 +++++------ src/HVACBusiness.php | 1076 +++++------ src/HairSalon.php | 1076 +++++------ src/HardwareStore.php | 1076 +++++------ src/HealthAndBeautyBusiness.php | 1076 +++++------ src/HealthClub.php | 1076 +++++------ src/HighSchool.php | 374 ++-- src/HinduTemple.php | 394 ++-- src/HobbyShop.php | 1076 +++++------ src/HomeAndConstructionBusiness.php | 1076 +++++------ src/HomeGoodsStore.php | 1076 +++++------ src/Hospital.php | 1040 +++++------ src/Hostel.php | 1078 +++++------ src/Hotel.php | 1078 +++++------ src/HotelRoom.php | 516 +++--- src/House.php | 497 +++-- src/HousePainter.php | 1076 +++++------ src/HowTo.php | 636 +++---- src/HowToDirection.php | 760 ++++---- src/HowToItem.php | 142 +- src/HowToSection.php | 632 +++---- src/HowToStep.php | 614 +++---- src/HowToSupply.php | 172 +- src/HowToTip.php | 486 ++--- src/HowToTool.php | 142 +- src/IceCreamShop.php | 1040 +++++------ src/IgnoreAction.php | 296 +-- src/ImageGallery.php | 726 ++++---- src/ImageObject.php | 1058 +++++------ src/IndividualProduct.php | 374 ++-- src/InformAction.php | 328 ++-- src/InsertAction.php | 334 ++-- src/InstallAction.php | 308 ++-- src/InsuranceAgency.php | 1088 +++++------ src/InteractAction.php | 296 +-- src/InteractionCounter.php | 32 +- src/InternetCafe.php | 1076 +++++------ src/InvestmentOrDeposit.php | 366 ++-- src/InviteAction.php | 328 ++-- src/Invoice.php | 290 +-- src/ItemList.php | 110 +- src/ItemPage.php | 726 ++++---- src/JewelryStore.php | 1076 +++++------ src/JobPosting.php | 370 ++-- src/JoinAction.php | 306 +-- src/LakeBodyOfWater.php | 336 ++-- src/Landform.php | 336 ++-- src/LandmarksOrHistoricalBuildings.php | 336 ++-- src/LeaveAction.php | 306 +-- src/LegalService.php | 1076 +++++------ src/LegislativeBuilding.php | 394 ++-- src/LendAction.php | 340 ++-- src/Library.php | 1076 +++++------ src/LikeAction.php | 296 +-- src/LiquorStore.php | 1076 +++++------ src/ListItem.php | 114 +- src/ListenAction.php | 308 ++-- src/LiteraryEvent.php | 372 ++-- src/LiveBlogPosting.php | 746 ++++---- src/LoanOrCredit.php | 420 ++--- src/LocalBusiness.php | 1076 +++++------ src/LocationFeatureSpecification.php | 306 +-- src/Locksmith.php | 1076 +++++------ src/LodgingBusiness.php | 1095 ++++++----- src/LodgingReservation.php | 386 ++-- src/LoseAction.php | 314 ++-- src/Map.php | 400 ++-- src/MarryAction.php | 296 +-- src/MediaObject.php | 907 +++++---- src/MediaSubscription.php | 60 +- src/MedicalOrganization.php | 364 ++-- src/MeetingRoom.php | 480 ++--- src/MensClothingStore.php | 1076 +++++------ src/Menu.php | 428 ++--- src/MenuItem.php | 478 +++-- src/MenuSection.php | 428 ++--- src/Message.php | 704 +++---- src/MiddleSchool.php | 374 ++-- src/MobileApplication.php | 1194 ++++++------ src/MobilePhoneStore.php | 1076 +++++------ src/MonetaryAmount.php | 146 +- src/MonetaryAmountDistribution.php | 184 +- src/Mosque.php | 394 ++-- src/Motel.php | 1078 +++++------ src/MotorcycleDealer.php | 1076 +++++------ src/MotorcycleRepair.php | 1076 +++++------ src/Mountain.php | 336 ++-- src/MoveAction.php | 328 ++-- src/Movie.php | 696 +++---- src/MovieClip.php | 678 +++---- src/MovieRentalStore.php | 1076 +++++------ src/MovieSeries.php | 728 ++++---- src/MovieTheater.php | 1050 +++++------ src/MovingCompany.php | 1076 +++++------ src/Museum.php | 394 ++-- src/MusicAlbum.php | 576 +++--- src/MusicComposition.php | 680 +++---- src/MusicEvent.php | 372 ++-- src/MusicGroup.php | 450 ++--- src/MusicPlaylist.php | 458 ++--- src/MusicRecording.php | 548 +++--- src/MusicRelease.php | 616 +++---- src/MusicStore.php | 1076 +++++------ src/MusicVenue.php | 394 ++-- src/MusicVideoObject.php | 924 +++++----- src/NGO.php | 364 ++-- src/NailSalon.php | 1076 +++++------ src/NewsArticle.php | 840 ++++----- src/NightClub.php | 1076 +++++------ src/Notary.php | 1076 +++++------ src/NoteDigitalDocument.php | 404 ++-- src/NutritionInformation.php | 266 +-- src/Occupation.php | 246 +-- src/OceanBodyOfWater.php | 336 ++-- src/Offer.php | 368 ++-- src/OfferCatalog.php | 110 +- src/OfficeEquipmentStore.php | 1076 +++++------ src/OnDemandEvent.php | 456 ++--- src/OpeningHoursSpecification.php | 136 +- src/Order.php | 284 +-- src/OrderAction.php | 392 ++-- src/OrderItem.php | 142 +- src/Organization.php | 364 ++-- src/OrganizationRole.php | 156 +- src/OrganizeAction.php | 296 +-- src/OutletStore.php | 1076 +++++------ src/OwnershipInfo.php | 84 +- src/PaintAction.php | 296 +-- src/Painting.php | 372 ++-- src/ParcelDelivery.php | 274 +-- src/ParentAudience.php | 246 +-- src/Park.php | 394 ++-- src/ParkingFacility.php | 394 ++-- src/PawnShop.php | 1076 +++++------ src/PayAction.php | 376 ++-- src/PaymentCard.php | 356 ++-- src/PaymentChargeSpecification.php | 346 ++-- src/PaymentService.php | 356 ++-- src/PeopleAudience.php | 226 +-- src/PerformAction.php | 340 ++-- src/PerformanceRole.php | 156 +- src/PerformingArtsTheater.php | 394 ++-- src/PerformingGroup.php | 364 ++-- src/Periodical.php | 496 ++--- src/Permit.php | 196 +- src/Person.php | 372 ++-- src/PetStore.php | 1076 +++++------ src/Pharmacy.php | 364 ++-- src/Photograph.php | 372 ++-- src/PhotographAction.php | 296 +-- src/Physician.php | 364 ++-- src/Place.php | 336 ++-- src/PlaceOfWorship.php | 394 ++-- src/PlanAction.php | 304 +-- src/PlayAction.php | 324 ++-- src/Playground.php | 394 ++-- src/Plumber.php | 1076 +++++------ src/PoliceStation.php | 1040 +++++------ src/Pond.php | 336 ++-- src/PostOffice.php | 1076 +++++------ src/PostalAddress.php | 266 +-- src/PreOrderAction.php | 382 ++-- src/PrependAction.php | 334 ++-- src/Preschool.php | 374 ++-- src/PresentationDigitalDocument.php | 404 ++-- src/PriceSpecification.php | 324 ++-- src/Product.php | 356 ++-- src/ProductModel.php | 430 ++--- src/ProfessionalService.php | 1076 +++++------ src/ProfilePage.php | 726 ++++---- src/ProgramMembership.php | 144 +- src/PropertyValue.php | 244 +-- src/PropertyValueSpecification.php | 284 +-- src/PublicSwimmingPool.php | 1076 +++++------ src/PublicationEvent.php | 442 +++-- src/PublicationIssue.php | 486 ++--- src/PublicationVolume.php | 482 ++--- src/QAPage.php | 726 ++++---- src/QualitativeValue.php | 202 +- src/QuantitativeValue.php | 196 +- src/QuantitativeValueDistribution.php | 140 +- src/Question.php | 510 ++--- src/QuoteAction.php | 382 ++-- src/RVPark.php | 394 ++-- src/RadioChannel.php | 150 +- src/RadioClip.php | 678 +++---- src/RadioEpisode.php | 706 +++---- src/RadioSeason.php | 736 ++++---- src/RadioSeries.php | 1076 ++++++----- src/RadioStation.php | 1076 +++++------ src/Rating.php | 158 +- src/ReactAction.php | 296 +-- src/ReadAction.php | 308 ++-- src/RealEstateAgent.php | 1076 +++++------ src/ReceiveAction.php | 332 ++-- src/Recipe.php | 948 +++++----- src/RecyclingCenter.php | 1076 +++++------ src/RegisterAction.php | 296 +-- src/RejectAction.php | 296 +-- src/RentAction.php | 394 ++-- src/RentalCarReservation.php | 338 ++-- src/ReplaceAction.php | 324 ++-- src/ReplyAction.php | 328 ++-- src/Report.php | 670 +++---- src/Reservation.php | 320 ++-- src/ReservationPackage.php | 324 ++-- src/ReserveAction.php | 304 +-- src/Reservoir.php | 336 ++-- src/Residence.php | 336 ++-- src/Resort.php | 1078 +++++------ src/Restaurant.php | 1040 +++++------ src/ResumeAction.php | 296 +-- src/ReturnAction.php | 322 ++-- src/Review.php | 492 ++--- src/ReviewAction.php | 306 +-- src/RiverBodyOfWater.php | 336 ++-- src/Role.php | 126 +- src/RoofingContractor.php | 1076 +++++------ src/Room.php | 480 ++--- src/RsvpAction.php | 368 ++-- src/SaleEvent.php | 372 ++-- src/ScheduleAction.php | 304 +-- src/ScholarlyArticle.php | 620 +++---- src/School.php | 374 ++-- src/ScreeningEvent.php | 432 ++--- src/Sculpture.php | 372 ++-- src/SeaBodyOfWater.php | 336 ++-- src/SearchAction.php | 304 +-- src/SearchResultsPage.php | 726 ++++---- src/Season.php | 372 ++-- src/Seat.php | 112 +- src/SelfStorage.php | 1076 +++++------ src/SellAction.php | 396 ++-- src/SendAction.php | 332 ++-- src/Series.php | 32 +- src/Service.php | 316 ++-- src/ServiceChannel.php | 222 +-- src/ShareAction.php | 324 ++-- src/ShoeStore.php | 1076 +++++------ src/ShoppingCenter.php | 1076 +++++------ src/SingleFamilyResidence.php | 515 +++--- src/SiteNavigationElement.php | 374 ++-- src/SkiResort.php | 1076 +++++------ src/SocialEvent.php | 372 ++-- src/SocialMediaPosting.php | 670 +++---- src/SoftwareApplication.php | 1106 +++++------ src/SoftwareSourceCode.php | 592 +++--- src/SomeProducts.php | 384 ++-- src/SportingGoodsStore.php | 1076 +++++------ src/SportsActivityLocation.php | 1076 +++++------ src/SportsClub.php | 1076 +++++------ src/SportsEvent.php | 456 ++--- src/SportsOrganization.php | 374 ++-- src/SportsTeam.php | 428 ++--- src/SpreadsheetDigitalDocument.php | 404 ++-- src/StadiumOrArena.php | 1040 +++++------ src/State.php | 336 ++-- src/SteeringPositionValue.php | 202 +- src/Store.php | 1076 +++++------ src/SubscribeAction.php | 296 +-- src/SubwayStation.php | 394 ++-- src/Suite.php | 533 +++--- src/SuspendAction.php | 296 +-- src/Synagogue.php | 394 ++-- src/TVClip.php | 694 +++---- src/TVEpisode.php | 756 ++++---- src/TVSeason.php | 780 ++++---- src/TVSeries.php | 1078 ++++++----- src/Table.php | 374 ++-- src/TakeAction.php | 328 ++-- src/TattooParlor.php | 1076 +++++------ src/Taxi.php | 316 ++-- src/TaxiReservation.php | 328 ++-- src/TaxiService.php | 316 ++-- src/TaxiStand.php | 394 ++-- src/TechArticle.php | 712 +++---- src/TelevisionChannel.php | 150 +- src/TelevisionStation.php | 1076 +++++------ src/TennisComplex.php | 1076 +++++------ src/TextDigitalDocument.php | 404 ++-- src/TheaterEvent.php | 372 ++-- src/TheaterGroup.php | 364 ++-- src/Ticket.php | 260 +-- src/TieAction.php | 296 +-- src/TipAction.php | 376 ++-- src/TireShop.php | 1076 +++++------ src/TouristAttraction.php | 380 ++-- src/TouristInformationCenter.php | 1076 +++++------ src/ToyStore.php | 1076 +++++------ src/TrackAction.php | 304 +-- src/TradeAction.php | 382 ++-- src/TrainReservation.php | 320 ++-- src/TrainStation.php | 394 ++-- src/TrainTrip.php | 200 +- src/TransferAction.php | 328 ++-- src/TravelAction.php | 338 ++-- src/TravelAgency.php | 1076 +++++------ src/Trip.php | 114 +- src/TypeAndQuantityNode.php | 146 +- src/UnRegisterAction.php | 296 +-- src/UnitPriceSpecification.php | 352 ++-- src/UpdateAction.php | 326 ++-- src/UseAction.php | 308 ++-- src/UserBlocks.php | 372 ++-- src/UserCheckins.php | 372 ++-- src/UserComments.php | 508 ++--- src/UserDownloads.php | 372 ++-- src/UserInteraction.php | 372 ++-- src/UserLikes.php | 372 ++-- src/UserPageVisits.php | 372 ++-- src/UserPlays.php | 372 ++-- src/UserPlusOnes.php | 372 ++-- src/UserTweets.php | 372 ++-- src/Vehicle.php | 942 +++++----- src/VideoGallery.php | 726 ++++---- src/VideoGame.php | 1634 ++++++++--------- src/VideoGameClip.php | 678 +++---- src/VideoGameSeries.php | 1342 +++++++------- src/VideoObject.php | 1238 ++++++------- src/ViewAction.php | 308 ++-- src/VisualArtsEvent.php | 372 ++-- src/VisualArtwork.php | 532 +++--- src/Volcano.php | 336 ++-- src/VoteAction.php | 322 ++-- src/WPAdBlock.php | 374 ++-- src/WPFooter.php | 374 ++-- src/WPHeader.php | 374 ++-- src/WPSideBar.php | 374 ++-- src/WantAction.php | 296 +-- src/WarrantyPromise.php | 58 +- src/WatchAction.php | 308 ++-- src/Waterfall.php | 336 ++-- src/WearAction.php | 308 ++-- src/WebApplication.php | 1194 ++++++------ src/WebPage.php | 726 ++++---- src/WebPageElement.php | 372 ++-- src/WebSite.php | 404 ++-- src/WholesaleStore.php | 1076 +++++------ src/WinAction.php | 304 +-- src/Winery.php | 1040 +++++------ src/WorkersUnion.php | 364 ++-- src/WriteAction.php | 328 ++-- src/Zoo.php | 394 ++-- 1144 files changed, 174199 insertions(+), 174450 deletions(-) diff --git a/src/AMRadioChannel.php b/src/AMRadioChannel.php index bb48597df..d9f908775 100644 --- a/src/AMRadioChannel.php +++ b/src/AMRadioChannel.php @@ -15,6 +15,39 @@ */ class AMRadioChannel extends BaseType implements RadioChannelContract, BroadcastChannelContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The unique address by which the BroadcastService can be identified in a * provider lineup. In US, this is typically a number. @@ -61,81 +94,6 @@ public function broadcastServiceTier($broadcastServiceTier) return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); } - /** - * Genre of the creative work, broadcast channel or group. - * - * @param string|string[] $genre - * - * @return static - * - * @see http://schema.org/genre - */ - public function genre($genre) - { - return $this->setProperty('genre', $genre); - } - - /** - * The CableOrSatelliteService offering the channel. - * - * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup - * - * @return static - * - * @see http://schema.org/inBroadcastLineup - */ - public function inBroadcastLineup($inBroadcastLineup) - { - return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); - } - - /** - * The BroadcastService offered on this channel. - * - * @param BroadcastService|BroadcastService[] $providesBroadcastService - * - * @return static - * - * @see http://schema.org/providesBroadcastService - */ - public function providesBroadcastService($providesBroadcastService) - { - return $this->setProperty('providesBroadcastService', $providesBroadcastService); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - /** * A description of the item. * @@ -167,6 +125,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -200,6 +172,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -245,6 +231,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + /** * 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 diff --git a/src/APIReference.php b/src/APIReference.php index 7ab5bc980..e1f970fd2 100644 --- a/src/APIReference.php +++ b/src/APIReference.php @@ -15,230 +15,6 @@ */ class APIReference extends BaseType implements TechArticleContract, ArticleContract, CreativeWorkContract, ThingContract { - /** - * Library file name e.g., mscorlib.dll, system.web.dll. - * - * @param string|string[] $assembly - * - * @return static - * - * @see http://schema.org/assembly - */ - public function assembly($assembly) - { - return $this->setProperty('assembly', $assembly); - } - - /** - * Associated product/technology version. e.g., .NET Framework 4.5. - * - * @param string|string[] $assemblyVersion - * - * @return static - * - * @see http://schema.org/assemblyVersion - */ - public function assemblyVersion($assemblyVersion) - { - return $this->setProperty('assemblyVersion', $assemblyVersion); - } - - /** - * Library file name e.g., mscorlib.dll, system.web.dll. - * - * @param string|string[] $executableLibraryName - * - * @return static - * - * @see http://schema.org/executableLibraryName - */ - public function executableLibraryName($executableLibraryName) - { - return $this->setProperty('executableLibraryName', $executableLibraryName); - } - - /** - * Indicates whether API is managed or unmanaged. - * - * @param string|string[] $programmingModel - * - * @return static - * - * @see http://schema.org/programmingModel - */ - public function programmingModel($programmingModel) - { - return $this->setProperty('programmingModel', $programmingModel); - } - - /** - * Type of app development: phone, Metro style, desktop, XBox, etc. - * - * @param string|string[] $targetPlatform - * - * @return static - * - * @see http://schema.org/targetPlatform - */ - public function targetPlatform($targetPlatform) - { - return $this->setProperty('targetPlatform', $targetPlatform); - } - - /** - * Prerequisites needed to fulfill steps in article. - * - * @param string|string[] $dependencies - * - * @return static - * - * @see http://schema.org/dependencies - */ - public function dependencies($dependencies) - { - return $this->setProperty('dependencies', $dependencies); - } - - /** - * Proficiency needed for this content; expected values: 'Beginner', - * 'Expert'. - * - * @param string|string[] $proficiencyLevel - * - * @return static - * - * @see http://schema.org/proficiencyLevel - */ - public function proficiencyLevel($proficiencyLevel) - { - return $this->setProperty('proficiencyLevel', $proficiencyLevel); - } - - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -383,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -398,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -412,6 +221,63 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + + /** + * Library file name e.g., mscorlib.dll, system.web.dll. + * + * @param string|string[] $assembly + * + * @return static + * + * @see http://schema.org/assembly + */ + public function assembly($assembly) + { + return $this->setProperty('assembly', $assembly); + } + + /** + * Associated product/technology version. e.g., .NET Framework 4.5. + * + * @param string|string[] $assemblyVersion + * + * @return static + * + * @see http://schema.org/assemblyVersion + */ + public function assemblyVersion($assemblyVersion) + { + return $this->setProperty('assemblyVersion', $assemblyVersion); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -686,7 +552,52 @@ public function dateModified($dateModified) */ public function datePublished($datePublished) { - return $this->setProperty('datePublished', $datePublished); + return $this->setProperty('datePublished', $datePublished); + } + + /** + * Prerequisites needed to fulfill steps in article. + * + * @param string|string[] $dependencies + * + * @return static + * + * @see http://schema.org/dependencies + */ + public function dependencies($dependencies) + { + return $this->setProperty('dependencies', $dependencies); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -817,6 +728,20 @@ public function exampleOfWork($exampleOfWork) return $this->setProperty('exampleOfWork', $exampleOfWork); } + /** + * Library file name e.g., mscorlib.dll, system.web.dll. + * + * @param string|string[] $executableLibraryName + * + * @return static + * + * @see http://schema.org/executableLibraryName + */ + public function executableLibraryName($executableLibraryName) + { + return $this->setProperty('executableLibraryName', $executableLibraryName); + } + /** * Date the content expires and is no longer useful or available. For * example a [[VideoObject]] or [[NewsArticle]] whose availability or @@ -914,6 +839,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1111,6 +1069,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1141,6 +1115,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1157,6 +1145,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1171,6 +1202,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1186,6 +1232,35 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * Proficiency needed for this content; expected values: 'Beginner', + * 'Expert'. + * + * @param string|string[] $proficiencyLevel + * + * @return static + * + * @see http://schema.org/proficiencyLevel + */ + public function proficiencyLevel($proficiencyLevel) + { + return $this->setProperty('proficiencyLevel', $proficiencyLevel); + } + + /** + * Indicates whether API is managed or unmanaged. + * + * @param string|string[] $programmingModel + * + * @return static + * + * @see http://schema.org/programmingModel + */ + public function programmingModel($programmingModel) + { + return $this->setProperty('programmingModel', $programmingModel); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1312,6 +1387,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1336,62 +1427,129 @@ public function schemaVersion($schemaVersion) * * @return static * - * @see http://schema.org/sourceOrganization + * @see http://schema.org/sourceOrganization + */ + public function sourceOrganization($sourceOrganization) + { + return $this->setProperty('sourceOrganization', $sourceOrganization); + } + + /** + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. + * + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable */ - public function sourceOrganization($sourceOrganization) + public function speakable($speakable) { - return $this->setProperty('sourceOrganization', $sourceOrganization); + return $this->setProperty('speakable', $speakable); } /** - * The "spatial" property can be used in cases when more specific properties - * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are - * not known to be appropriate. + * 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. * - * @param Place|Place[] $spatial + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/spatial + * @see http://schema.org/sponsor */ - public function spatial($spatial) + public function sponsor($sponsor) { - return $this->setProperty('spatial', $spatial); + return $this->setProperty('sponsor', $sponsor); } /** - * The spatialCoverage of a CreativeWork indicates the place(s) which are - * the focus of the content. It is a subproperty of - * contentLocation intended primarily for more technical and detailed - * materials. For example with a Dataset, it indicates - * areas that the dataset describes: a dataset of New York weather - * would have spatialCoverage which was the place: the state of New York. + * A CreativeWork or Event about this Thing. * - * @param Place|Place[] $spatialCoverage + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/subjectOf */ - public function spatialCoverage($spatialCoverage) + public function subjectOf($subjectOf) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Type of app development: phone, Metro style, desktop, XBox, etc. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param string|string[] $targetPlatform * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/targetPlatform */ - public function sponsor($sponsor) + public function targetPlatform($targetPlatform) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('targetPlatform', $targetPlatform); } /** @@ -1515,6 +1673,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1544,204 +1716,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/AboutPage.php b/src/AboutPage.php index da917d9f9..503ae4ce1 100644 --- a/src/AboutPage.php +++ b/src/AboutPage.php @@ -14,176 +14,6 @@ */ class AboutPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -328,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -343,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -444,6 +307,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -634,6 +512,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -860,13 +769,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -996,6 +938,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1041,6 +998,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1056,6 +1027,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1086,6 +1073,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1116,6 +1117,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1214,6 +1244,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1243,6 +1287,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1257,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1274,6 +1349,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1323,6 +1428,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1339,6 +1497,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1460,6 +1632,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1503,190 +1689,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/AcceptAction.php b/src/AcceptAction.php index 9f2495c97..ab6154ad1 100644 --- a/src/AcceptAction.php +++ b/src/AcceptAction.php @@ -34,340 +34,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Accommodation.php b/src/Accommodation.php index c10ba9806..94d3de239 100644 --- a/src/Accommodation.php +++ b/src/Accommodation.php @@ -20,85 +20,6 @@ */ class Accommodation extends BaseType implements PlaceContract, ThingContract { - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard - * - * @param QuantitativeValue|QuantitativeValue[] $floorSize - * - * @return static - * - * @see http://schema.org/floorSize - */ - public function floorSize($floorSize) - { - return $this->setProperty('floorSize', $floorSize); - } - - /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms - * - * @return static - * - * @see http://schema.org/numberOfRooms - */ - public function numberOfRooms($numberOfRooms) - { - return $this->setProperty('numberOfRooms', $numberOfRooms); - } - - /** - * Indications regarding the permitted usage of the accommodation. - * - * @param string|string[] $permittedUsage - * - * @return static - * - * @see http://schema.org/permittedUsage - */ - public function permittedUsage($permittedUsage) - { - return $this->setProperty('permittedUsage', $permittedUsage); - } - - /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. - * - * @param bool|bool[]|string|string[] $petsAllowed - * - * @return static - * - * @see http://schema.org/petsAllowed - */ - public function petsAllowed($petsAllowed) - { - return $this->setProperty('petsAllowed', $petsAllowed); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -121,6 +42,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -150,6 +90,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -230,6 +184,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -273,6 +258,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -318,6 +319,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -392,6 +426,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -435,320 +485,253 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * A review of the item. + * The name of the item. * - * @param Review|Review[] $review + * @param string|string[] $name * * @return static * - * @see http://schema.org/review + * @see http://schema.org/name */ - public function review($review) + public function name($name) { - return $this->setProperty('review', $review); + return $this->setProperty('name', $name); } /** - * Review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/numberOfRooms */ - public function reviews($reviews) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/AccountingService.php b/src/AccountingService.php index d2d6dc17a..e0db635bd 100644 --- a/src/AccountingService.php +++ b/src/AccountingService.php @@ -20,183 +20,181 @@ class AccountingService extends BaseType implements FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $feesAndCommissionsSpecification + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/additionalProperty */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function additionalProperty($additionalProperty) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/additionalType */ - public function branchOf($branchOf) + public function additionalType($additionalType) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Physical address of the item. * - * @param string|string[] $currenciesAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/address */ - public function currenciesAccepted($currenciesAccepted) + public function address($address) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('address', $address); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $openingHours + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/aggregateRating */ - public function openingHours($openingHours) + public function aggregateRating($aggregateRating) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * An alias for the item. * - * @param string|string[] $paymentAccepted + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/alternateName */ - public function paymentAccepted($paymentAccepted) + public function alternateName($alternateName) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('alternateName', $alternateName); } /** - * The price range of the business, for example ```$$$```. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $priceRange + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/amenityFeature */ - public function priceRange($priceRange) + public function amenityFeature($amenityFeature) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Physical address of the item. + * The geographic area where a service or offered item is provided. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/address + * @see http://schema.org/areaServed */ - public function address($address) + public function areaServed($areaServed) { - return $this->setProperty('address', $address); + return $this->setProperty('areaServed', $areaServed); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An award won by or for this item. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $award * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/award */ - public function aggregateRating($aggregateRating) + public function award($award) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('award', $award); } /** - * The geographic area where a service or offered item is provided. + * Awards won by or for this item. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param string|string[] $awards * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/awards */ - public function areaServed($areaServed) + public function awards($awards) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('awards', $awards); } /** - * An award won by or for this item. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param string|string[] $award + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/award + * @see http://schema.org/branchCode */ - public function award($award) + public function branchCode($branchCode) { - return $this->setProperty('award', $award); + return $this->setProperty('branchCode', $branchCode); } /** - * Awards won by or for this item. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $awards + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/branchOf */ - public function awards($awards) + public function branchOf($branchOf) { - return $this->setProperty('awards', $awards); + return $this->setProperty('branchOf', $branchOf); } /** @@ -242,6 +240,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -259,6 +322,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -373,6 +467,21 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + /** * A person who founded this organization. * @@ -444,6 +553,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -461,6 +584,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -490,6 +627,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -506,6 +690,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -564,6 +763,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -578,6 +808,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -637,6 +909,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -665,6 +951,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -695,664 +1024,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/photos */ - public function reviews($reviews) + public function photos($photos) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Demand|Demand[] $seeks + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/potentialAction */ - public function seeks($seeks) + public function potentialAction($potentialAction) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The geographic area where the service is provided. + * The price range of the business, for example ```$$$```. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/priceRange */ - public function serviceArea($serviceArea) + public function priceRange($priceRange) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('priceRange', $priceRange); } /** - * A slogan or motto associated with the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $slogan + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/publicAccess */ - public function slogan($slogan) + public function publicAccess($publicAccess) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/publishingPrinciples */ - public function sponsor($sponsor) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A review of the item. * - * @param Organization|Organization[] $subOrganization + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/review */ - public function subOrganization($subOrganization) + public function review($review) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('review', $review); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * Review of the item. * - * @param string|string[] $taxID + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/reviews */ - public function taxID($taxID) + public function reviews($reviews) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('reviews', $reviews); } /** - * The telephone number. + * 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. * - * @param string|string[] $telephone + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/sameAs */ - public function telephone($telephone) + public function sameAs($sameAs) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('sameAs', $sameAs); } /** - * The Value-added Tax ID of the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param string|string[] $vatID + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/seeks */ - public function vatID($vatID) + public function seeks($seeks) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('seeks', $seeks); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geographic area where the service is provided. * - * @param string|string[] $additionalType + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/serviceArea */ - public function additionalType($additionalType) + public function serviceArea($serviceArea) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('serviceArea', $serviceArea); } /** - * An alias for the item. + * A slogan or motto associated with the item. * - * @param string|string[] $alternateName + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/slogan */ - public function alternateName($alternateName) + public function slogan($slogan) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('slogan', $slogan); } /** - * A description of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $description + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/description + * @see http://schema.org/smokingAllowed */ - public function description($description) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('description', $description); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * 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. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $disambiguatingDescription + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/specialOpeningHoursSpecification */ - public function disambiguatingDescription($disambiguatingDescription) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sponsor */ - public function identifier($identifier) + public function sponsor($sponsor) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sponsor', $sponsor); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/image + * @see http://schema.org/subOrganization */ - public function image($image) + public function subOrganization($subOrganization) { - return $this->setProperty('image', $image); + return $this->setProperty('subOrganization', $subOrganization); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A CreativeWork or Event about this Thing. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/subjectOf */ - public function mainEntityOfPage($mainEntityOfPage) + public function subjectOf($subjectOf) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('subjectOf', $subjectOf); } /** - * The name of the item. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param string|string[] $name + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/name + * @see http://schema.org/taxID */ - public function name($name) + public function taxID($taxID) { - return $this->setProperty('name', $name); + return $this->setProperty('taxID', $taxID); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The telephone number. * - * @param Action|Action[] $potentialAction + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/telephone */ - public function potentialAction($potentialAction) + public function telephone($telephone) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('telephone', $telephone); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The Value-added Tax ID of the organization or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/vatID */ - public function subjectOf($subjectOf) + public function vatID($vatID) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty - * - * @return static - * - * @see http://schema.org/additionalProperty - */ - public function additionalProperty($additionalProperty) - { - return $this->setProperty('additionalProperty', $additionalProperty); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. - * - * @param string|string[] $branchCode - * - * @return static - * - * @see http://schema.org/branchCode - */ - public function branchCode($branchCode) - { - return $this->setProperty('branchCode', $branchCode); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedIn - * - * @return static - * - * @see http://schema.org/containedIn - */ - public function containedIn($containedIn) - { - return $this->setProperty('containedIn', $containedIn); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedInPlace - * - * @return static - * - * @see http://schema.org/containedInPlace - */ - public function containedInPlace($containedInPlace) - { - return $this->setProperty('containedInPlace', $containedInPlace); - } - - /** - * The basic containment relation between a place and another that it - * contains. - * - * @param Place|Place[] $containsPlace - * - * @return static - * - * @see http://schema.org/containsPlace - */ - public function containsPlace($containsPlace) - { - return $this->setProperty('containsPlace', $containsPlace); - } - - /** - * The geo coordinates of the place. - * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo - * - * @return static - * - * @see http://schema.org/geo - */ - public function geo($geo) - { - return $this->setProperty('geo', $geo); - } - - /** - * A URL to a map of the place. - * - * @param Map|Map[]|string|string[] $hasMap - * - * @return static - * - * @see http://schema.org/hasMap - */ - public function hasMap($hasMap) - { - return $this->setProperty('hasMap', $hasMap); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $latitude - * - * @return static - * - * @see http://schema.org/latitude - */ - public function latitude($latitude) - { - return $this->setProperty('latitude', $latitude); - } - - /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $longitude - * - * @return static - * - * @see http://schema.org/longitude - */ - public function longitude($longitude) - { - return $this->setProperty('longitude', $longitude); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $map - * - * @return static - * - * @see http://schema.org/map - */ - public function map($map) - { - return $this->setProperty('map', $map); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $maps - * - * @return static - * - * @see http://schema.org/maps - */ - public function maps($maps) - { - return $this->setProperty('maps', $maps); - } - - /** - * The total number of individuals that may attend an event or venue. - * - * @param int|int[] $maximumAttendeeCapacity - * - * @return static - * - * @see http://schema.org/maximumAttendeeCapacity - */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) - { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); - } - - /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. - * - * @param bool|bool[] $smokingAllowed - * - * @return static - * - * @see http://schema.org/smokingAllowed - */ - public function smokingAllowed($smokingAllowed) - { - return $this->setProperty('smokingAllowed', $smokingAllowed); - } - - /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification - * - * @return static - * - * @see http://schema.org/specialOpeningHoursSpecification - */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) - { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AchieveAction.php b/src/AchieveAction.php index 2c7ee7dcc..e18904164 100644 --- a/src/AchieveAction.php +++ b/src/AchieveAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Action.php b/src/Action.php index f540f83d0..090084d15 100644 --- a/src/Action.php +++ b/src/Action.php @@ -34,340 +34,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ActionAccessSpecification.php b/src/ActionAccessSpecification.php index 6c580a4bf..ba821de6e 100644 --- a/src/ActionAccessSpecification.php +++ b/src/ActionAccessSpecification.php @@ -14,151 +14,137 @@ class ActionAccessSpecification extends BaseType implements IntangibleContract, ThingContract { /** - * - * - * @param $availabilityEnds - * - * @return static - * - * @see http://schema.org/availabilityEnds - */ - public function availabilityEnds($availabilityEnds) - { - return $this->setProperty('availabilityEnds', $availabilityEnds); - } - - /** - * + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param $availabilityStarts + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/availabilityStarts + * @see http://schema.org/additionalType */ - public function availabilityStarts($availabilityStarts) + public function additionalType($additionalType) { - return $this->setProperty('availabilityStarts', $availabilityStarts); + return $this->setProperty('additionalType', $additionalType); } /** - * + * An alias for the item. * - * @param $category + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/category + * @see http://schema.org/alternateName */ - public function category($category) + public function alternateName($alternateName) { - return $this->setProperty('category', $category); + return $this->setProperty('alternateName', $alternateName); } /** * * - * @param $eligibleRegion + * @param $availabilityEnds * * @return static * - * @see http://schema.org/eligibleRegion + * @see http://schema.org/availabilityEnds */ - public function eligibleRegion($eligibleRegion) + public function availabilityEnds($availabilityEnds) { - return $this->setProperty('eligibleRegion', $eligibleRegion); + return $this->setProperty('availabilityEnds', $availabilityEnds); } /** * * - * @param $expectsAcceptanceOf + * @param $availabilityStarts * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/availabilityStarts */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function availabilityStarts($availabilityStarts) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('availabilityStarts', $availabilityStarts); } /** * * - * @param MediaSubscription|MediaSubscription[] $requiresSubscription + * @param $category * * @return static * - * @see http://schema.org/requiresSubscription + * @see http://schema.org/category */ - public function requiresSubscription($requiresSubscription) + public function category($category) { - return $this->setProperty('requiresSubscription', $requiresSubscription); + return $this->setProperty('category', $category); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * A description of the item. * - * @param string|string[] $additionalType + * @param string|string[] $description * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/description */ - public function additionalType($additionalType) + public function description($description) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('description', $description); } /** - * An alias for the item. + * 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. * - * @param string|string[] $alternateName + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/disambiguatingDescription */ - public function alternateName($alternateName) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A description of the item. + * * - * @param string|string[] $description + * @param $eligibleRegion * * @return static * - * @see http://schema.org/description + * @see http://schema.org/eligibleRegion */ - public function description($description) + public function eligibleRegion($eligibleRegion) { - return $this->setProperty('description', $description); + return $this->setProperty('eligibleRegion', $eligibleRegion); } /** - * 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. + * * - * @param string|string[] $disambiguatingDescription + * @param $expectsAcceptanceOf * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/expectsAcceptanceOf */ - public function disambiguatingDescription($disambiguatingDescription) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** @@ -239,6 +225,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * + * + * @param MediaSubscription|MediaSubscription[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + /** * 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 diff --git a/src/ActivateAction.php b/src/ActivateAction.php index 8e5f48516..debecc9cc 100644 --- a/src/ActivateAction.php +++ b/src/ActivateAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/AddAction.php b/src/AddAction.php index 7b5b31f8f..a01e04a36 100644 --- a/src/AddAction.php +++ b/src/AddAction.php @@ -15,382 +15,382 @@ class AddAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract { /** - * A sub property of object. The collection target of the action. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $collection + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/collection + * @see http://schema.org/actionStatus */ - public function collection($collection) + public function actionStatus($actionStatus) { - return $this->setProperty('collection', $collection); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of object. The collection target of the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $targetCollection + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/targetCollection + * @see http://schema.org/additionalType */ - public function targetCollection($targetCollection) + public function additionalType($additionalType) { - return $this->setProperty('targetCollection', $targetCollection); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of object. The collection target of the action. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Thing|Thing[] $collection * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/collection */ - public function endTime($endTime) + public function collection($collection) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('collection', $collection); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of object. The collection target of the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Thing|Thing[] $targetCollection * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/targetCollection */ - public function subjectOf($subjectOf) + public function targetCollection($targetCollection) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('targetCollection', $targetCollection); } /** diff --git a/src/AdministrativeArea.php b/src/AdministrativeArea.php index 88dc840ce..aac888d4c 100644 --- a/src/AdministrativeArea.php +++ b/src/AdministrativeArea.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/AdultEntertainment.php b/src/AdultEntertainment.php index a1ed67028..cf8ee9839 100644 --- a/src/AdultEntertainment.php +++ b/src/AdultEntertainment.php @@ -17,126 +17,104 @@ class AdultEntertainment extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AggregateOffer.php b/src/AggregateOffer.php index 483165865..0e334299d 100644 --- a/src/AggregateOffer.php +++ b/src/AggregateOffer.php @@ -16,78 +16,6 @@ */ class AggregateOffer extends BaseType implements OfferContract, IntangibleContract, ThingContract { - /** - * The highest price of all offers available. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param float|float[]|int|int[]|string|string[] $highPrice - * - * @return static - * - * @see http://schema.org/highPrice - */ - public function highPrice($highPrice) - { - return $this->setProperty('highPrice', $highPrice); - } - - /** - * The lowest price of all offers available. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param float|float[]|int|int[]|string|string[] $lowPrice - * - * @return static - * - * @see http://schema.org/lowPrice - */ - public function lowPrice($lowPrice) - { - return $this->setProperty('lowPrice', $lowPrice); - } - - /** - * The number of offers for the product. - * - * @param int|int[] $offerCount - * - * @return static - * - * @see http://schema.org/offerCount - */ - public function offerCount($offerCount) - { - return $this->setProperty('offerCount', $offerCount); - } - - /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. - * - * @param Offer|Offer[] $offers - * - * @return static - * - * @see http://schema.org/offers - */ - public function offers($offers) - { - return $this->setProperty('offers', $offers); - } - /** * The payment method(s) accepted by seller for this offer. * @@ -118,6 +46,25 @@ public function addOn($addOn) return $this->setProperty('addOn', $addOn); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The amount of time that is required between accepting the offer and the * actual usage of the resource or service. @@ -148,6 +95,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -282,6 +243,37 @@ public function deliveryLeadTime($deliveryLeadTime) return $this->setProperty('deliveryLeadTime', $deliveryLeadTime); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The type(s) of customers for which the given offer is valid. * @@ -434,6 +426,60 @@ public function gtin8($gtin8) return $this->setProperty('gtin8', $gtin8); } + /** + * The highest price of all offers available. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $highPrice + * + * @return static + * + * @see http://schema.org/highPrice + */ + public function highPrice($highPrice) + { + return $this->setProperty('highPrice', $highPrice); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * This links to a node or nodes indicating the exact quantity of the * products included in the offer. @@ -512,6 +558,43 @@ public function itemOffered($itemOffered) return $this->setProperty('itemOffered', $itemOffered); } + /** + * The lowest price of all offers available. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $lowPrice + * + * @return static + * + * @see http://schema.org/lowPrice + */ + public function lowPrice($lowPrice) + { + return $this->setProperty('lowPrice', $lowPrice); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The Manufacturer Part Number (MPN) of the product, or the product to * which the offer refers. @@ -527,6 +610,65 @@ public function mpn($mpn) return $this->setProperty('mpn', $mpn); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of offers for the product. + * + * @param int|int[] $offerCount + * + * @return static + * + * @see http://schema.org/offerCount + */ + public function offerCount($offerCount) + { + return $this->setProperty('offerCount', $offerCount); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The offer price of a product, or of a price component when attached to * PriceSpecification and its subtypes. @@ -644,6 +786,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * An entity which offers (sells / leases / lends / loans) the services / * goods. A seller may also be a provider. @@ -691,232 +849,74 @@ public function sku($sku) } /** - * The date when the item becomes valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom - * - * @return static - * - * @see http://schema.org/validFrom - */ - public function validFrom($validFrom) - { - return $this->setProperty('validFrom', $validFrom); - } - - /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough - * - * @return static - * - * @see http://schema.org/validThrough - */ - public function validThrough($validThrough) - { - return $this->setProperty('validThrough', $validThrough); - } - - /** - * The warranty promise(s) included in the offer. - * - * @param WarrantyPromise|WarrantyPromise[] $warranty - * - * @return static - * - * @see http://schema.org/warranty - */ - public function warranty($warranty) - { - return $this->setProperty('warranty', $warranty); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The date when the item becomes valid. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validFrom */ - public function sameAs($sameAs) + public function validFrom($validFrom) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validFrom', $validFrom); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * The warranty promise(s) included in the offer. * - * @param string|string[] $url + * @param WarrantyPromise|WarrantyPromise[] $warranty * * @return static * - * @see http://schema.org/url + * @see http://schema.org/warranty */ - public function url($url) + public function warranty($warranty) { - return $this->setProperty('url', $url); + return $this->setProperty('warranty', $warranty); } } diff --git a/src/AggregateRating.php b/src/AggregateRating.php index a38538a57..2afa68d5b 100644 --- a/src/AggregateRating.php +++ b/src/AggregateRating.php @@ -15,45 +15,36 @@ class AggregateRating extends BaseType implements RatingContract, IntangibleContract, ThingContract { /** - * The item that is being reviewed/rated. - * - * @param Thing|Thing[] $itemReviewed - * - * @return static - * - * @see http://schema.org/itemReviewed - */ - public function itemReviewed($itemReviewed) - { - return $this->setProperty('itemReviewed', $itemReviewed); - } - - /** - * The count of total number of ratings. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param int|int[] $ratingCount + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/ratingCount + * @see http://schema.org/additionalType */ - public function ratingCount($ratingCount) + public function additionalType($additionalType) { - return $this->setProperty('ratingCount', $ratingCount); + return $this->setProperty('additionalType', $additionalType); } /** - * The count of total number of reviews. + * An alias for the item. * - * @param int|int[] $reviewCount + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/reviewCount + * @see http://schema.org/alternateName */ - public function reviewCount($reviewCount) + public function alternateName($alternateName) { - return $this->setProperty('reviewCount', $reviewCount); + return $this->setProperty('alternateName', $alternateName); } /** @@ -87,90 +78,6 @@ public function bestRating($bestRating) return $this->setProperty('bestRating', $bestRating); } - /** - * The rating for the content. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param float|float[]|int|int[]|string|string[] $ratingValue - * - * @return static - * - * @see http://schema.org/ratingValue - */ - public function ratingValue($ratingValue) - { - return $this->setProperty('ratingValue', $ratingValue); - } - - /** - * This Review or Rating is relevant to this part or facet of the - * itemReviewed. - * - * @param string|string[] $reviewAspect - * - * @return static - * - * @see http://schema.org/reviewAspect - */ - public function reviewAspect($reviewAspect) - { - return $this->setProperty('reviewAspect', $reviewAspect); - } - - /** - * The lowest value allowed in this rating system. If worstRating is - * omitted, 1 is assumed. - * - * @param float|float[]|int|int[]|string|string[] $worstRating - * - * @return static - * - * @see http://schema.org/worstRating - */ - public function worstRating($worstRating) - { - return $this->setProperty('worstRating', $worstRating); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - /** * A description of the item. * @@ -235,6 +142,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The item that is being reviewed/rated. + * + * @param Thing|Thing[] $itemReviewed + * + * @return static + * + * @see http://schema.org/itemReviewed + */ + public function itemReviewed($itemReviewed) + { + return $this->setProperty('itemReviewed', $itemReviewed); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -280,6 +201,70 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The count of total number of ratings. + * + * @param int|int[] $ratingCount + * + * @return static + * + * @see http://schema.org/ratingCount + */ + public function ratingCount($ratingCount) + { + return $this->setProperty('ratingCount', $ratingCount); + } + + /** + * The rating for the content. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $ratingValue + * + * @return static + * + * @see http://schema.org/ratingValue + */ + public function ratingValue($ratingValue) + { + return $this->setProperty('ratingValue', $ratingValue); + } + + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + + /** + * The count of total number of reviews. + * + * @param int|int[] $reviewCount + * + * @return static + * + * @see http://schema.org/reviewCount + */ + public function reviewCount($reviewCount) + { + return $this->setProperty('reviewCount', $reviewCount); + } + /** * 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 @@ -324,4 +309,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The lowest value allowed in this rating system. If worstRating is + * omitted, 1 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $worstRating + * + * @return static + * + * @see http://schema.org/worstRating + */ + public function worstRating($worstRating) + { + return $this->setProperty('worstRating', $worstRating); + } + } diff --git a/src/AgreeAction.php b/src/AgreeAction.php index 1aebc9e28..8b5b29f89 100644 --- a/src/AgreeAction.php +++ b/src/AgreeAction.php @@ -31,340 +31,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Airline.php b/src/Airline.php index 5b9ee1f27..7a3e85ba4 100644 --- a/src/Airline.php +++ b/src/Airline.php @@ -14,32 +14,22 @@ class Airline extends BaseType implements OrganizationContract, ThingContract { /** - * The type of boarding policy used by the airline (e.g. zone-based or - * group-based). - * - * @param BoardingPolicyType|BoardingPolicyType[] $boardingPolicy - * - * @return static - * - * @see http://schema.org/boardingPolicy - */ - public function boardingPolicy($boardingPolicy) - { - return $this->setProperty('boardingPolicy', $boardingPolicy); - } - - /** - * IATA identifier for an airline or airport. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $iataCode + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/iataCode + * @see http://schema.org/additionalType */ - public function iataCode($iataCode) + public function additionalType($additionalType) { - return $this->setProperty('iataCode', $iataCode); + return $this->setProperty('additionalType', $additionalType); } /** @@ -71,6 +61,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -113,6 +117,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The type of boarding policy used by the airline (e.g. zone-based or + * group-based). + * + * @param BoardingPolicyType|BoardingPolicyType[] $boardingPolicy + * + * @return static + * + * @see http://schema.org/boardingPolicy + */ + public function boardingPolicy($boardingPolicy) + { + return $this->setProperty('boardingPolicy', $boardingPolicy); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -173,6 +192,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -404,6 +454,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * IATA identifier for an airline or airport. + * + * @param string|string[] $iataCode + * + * @return static + * + * @see http://schema.org/iataCode + */ + public function iataCode($iataCode) + { + return $this->setProperty('iataCode', $iataCode); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -478,6 +575,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -551,6 +664,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -608,6 +735,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -660,6 +802,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -735,6 +893,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -765,203 +937,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Airport.php b/src/Airport.php index 7456875b0..641c0f1dd 100644 --- a/src/Airport.php +++ b/src/Airport.php @@ -14,63 +14,6 @@ */ class Airport extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * IATA identifier for an airline or airport. - * - * @param string|string[] $iataCode - * - * @return static - * - * @see http://schema.org/iataCode - */ - public function iataCode($iataCode) - { - return $this->setProperty('iataCode', $iataCode); - } - - /** - * ICAO identifier for an airport. - * - * @param string|string[] $icaoCode - * - * @return static - * - * @see http://schema.org/icaoCode - */ - public function icaoCode($icaoCode) - { - return $this->setProperty('icaoCode', $icaoCode); - } - - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -93,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -122,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -202,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -290,6 +297,67 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * IATA identifier for an airline or airport. + * + * @param string|string[] $iataCode + * + * @return static + * + * @see http://schema.org/iataCode + */ + public function iataCode($iataCode) + { + return $this->setProperty('iataCode', $iataCode); + } + + /** + * ICAO identifier for an airport. + * + * @param string|string[] $icaoCode + * + * @return static + * + * @see http://schema.org/icaoCode + */ + public function icaoCode($icaoCode) + { + return $this->setProperty('icaoCode', $icaoCode); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -364,6 +432,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -406,6 +490,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -448,6 +575,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -491,6 +633,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -538,189 +696,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/AlignmentObject.php b/src/AlignmentObject.php index ecbc906d3..93d762f6d 100644 --- a/src/AlignmentObject.php +++ b/src/AlignmentObject.php @@ -14,79 +14,6 @@ */ class AlignmentObject extends BaseType implements IntangibleContract, ThingContract { - /** - * A category of alignment between the learning resource and the framework - * node. Recommended values include: 'assesses', 'teaches', 'requires', - * 'textComplexity', 'readingLevel', 'educationalSubject', and - * 'educationalLevel'. - * - * @param string|string[] $alignmentType - * - * @return static - * - * @see http://schema.org/alignmentType - */ - public function alignmentType($alignmentType) - { - return $this->setProperty('alignmentType', $alignmentType); - } - - /** - * The framework to which the resource being described is aligned. - * - * @param string|string[] $educationalFramework - * - * @return static - * - * @see http://schema.org/educationalFramework - */ - public function educationalFramework($educationalFramework) - { - return $this->setProperty('educationalFramework', $educationalFramework); - } - - /** - * The description of a node in an established educational framework. - * - * @param string|string[] $targetDescription - * - * @return static - * - * @see http://schema.org/targetDescription - */ - public function targetDescription($targetDescription) - { - return $this->setProperty('targetDescription', $targetDescription); - } - - /** - * The name of a node in an established educational framework. - * - * @param string|string[] $targetName - * - * @return static - * - * @see http://schema.org/targetName - */ - public function targetName($targetName) - { - return $this->setProperty('targetName', $targetName); - } - - /** - * The URL of a node in an established educational framework. - * - * @param string|string[] $targetUrl - * - * @return static - * - * @see http://schema.org/targetUrl - */ - public function targetUrl($targetUrl) - { - return $this->setProperty('targetUrl', $targetUrl); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -106,6 +33,23 @@ public function additionalType($additionalType) return $this->setProperty('additionalType', $additionalType); } + /** + * A category of alignment between the learning resource and the framework + * node. Recommended values include: 'assesses', 'teaches', 'requires', + * 'textComplexity', 'readingLevel', 'educationalSubject', and + * 'educationalLevel'. + * + * @param string|string[] $alignmentType + * + * @return static + * + * @see http://schema.org/alignmentType + */ + public function alignmentType($alignmentType) + { + return $this->setProperty('alignmentType', $alignmentType); + } + /** * An alias for the item. * @@ -151,6 +95,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The framework to which the resource being described is aligned. + * + * @param string|string[] $educationalFramework + * + * @return static + * + * @see http://schema.org/educationalFramework + */ + public function educationalFramework($educationalFramework) + { + return $this->setProperty('educationalFramework', $educationalFramework); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -259,6 +217,48 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The description of a node in an established educational framework. + * + * @param string|string[] $targetDescription + * + * @return static + * + * @see http://schema.org/targetDescription + */ + public function targetDescription($targetDescription) + { + return $this->setProperty('targetDescription', $targetDescription); + } + + /** + * The name of a node in an established educational framework. + * + * @param string|string[] $targetName + * + * @return static + * + * @see http://schema.org/targetName + */ + public function targetName($targetName) + { + return $this->setProperty('targetName', $targetName); + } + + /** + * The URL of a node in an established educational framework. + * + * @param string|string[] $targetUrl + * + * @return static + * + * @see http://schema.org/targetUrl + */ + public function targetUrl($targetUrl) + { + return $this->setProperty('targetUrl', $targetUrl); + } + /** * URL of the item. * diff --git a/src/AllocateAction.php b/src/AllocateAction.php index 6a96ba762..0c05be0b7 100644 --- a/src/AllocateAction.php +++ b/src/AllocateAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/AmusementPark.php b/src/AmusementPark.php index 2e9b5434e..b487ff0b9 100644 --- a/src/AmusementPark.php +++ b/src/AmusementPark.php @@ -17,126 +17,104 @@ class AmusementPark extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AnimalShelter.php b/src/AnimalShelter.php index 414cff9c9..be2159a0d 100644 --- a/src/AnimalShelter.php +++ b/src/AnimalShelter.php @@ -16,126 +16,104 @@ class AnimalShelter extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Answer.php b/src/Answer.php index 00bcf38c3..3e0fcc040 100644 --- a/src/Answer.php +++ b/src/Answer.php @@ -15,50 +15,6 @@ */ class Answer extends BaseType implements CommentContract, CreativeWorkContract, ThingContract { - /** - * The number of downvotes this question, answer or comment has received - * from the community. - * - * @param int|int[] $downvoteCount - * - * @return static - * - * @see http://schema.org/downvoteCount - */ - public function downvoteCount($downvoteCount) - { - return $this->setProperty('downvoteCount', $downvoteCount); - } - - /** - * The parent of a question, answer or item in general. - * - * @param Question|Question[] $parentItem - * - * @return static - * - * @see http://schema.org/parentItem - */ - public function parentItem($parentItem) - { - return $this->setProperty('parentItem', $parentItem); - } - - /** - * The number of upvotes this question, answer or comment has received from - * the community. - * - * @param int|int[] $upvoteCount - * - * @return static - * - * @see http://schema.org/upvoteCount - */ - public function upvoteCount($upvoteCount) - { - return $this->setProperty('upvoteCount', $upvoteCount); - } - /** * The subject matter of the content. * @@ -203,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -218,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -509,6 +498,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -523,6 +543,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The number of downvotes this question, answer or comment has received + * from the community. + * + * @param int|int[] $downvoteCount + * + * @return static + * + * @see http://schema.org/downvoteCount + */ + public function downvoteCount($downvoteCount) + { + return $this->setProperty('downvoteCount', $downvoteCount); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -734,6 +769,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -931,6 +999,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -961,6 +1045,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -977,6 +1075,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The parent of a question, answer or item in general. + * + * @param Question|Question[] $parentItem + * + * @return static + * + * @see http://schema.org/parentItem + */ + public function parentItem($parentItem) + { + return $this->setProperty('parentItem', $parentItem); + } + /** * The position of an item in a series or sequence of items. * @@ -991,6 +1103,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1132,6 +1259,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1214,6 +1357,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1336,232 +1493,75 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. + * The number of upvotes this question, answer or comment has received from + * the community. * - * @param string|string[] $name + * @param int|int[] $upvoteCount * * @return static * - * @see http://schema.org/name + * @see http://schema.org/upvoteCount */ - public function name($name) + public function upvoteCount($upvoteCount) { - return $this->setProperty('name', $name); + return $this->setProperty('upvoteCount', $upvoteCount); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The version of the CreativeWork embodied by a specified resource. * - * @param string|string[] $sameAs + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/version */ - public function sameAs($sameAs) + public function version($version) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('version', $version); } /** - * A CreativeWork or Event about this Thing. + * An embedded video object. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/video */ - public function subjectOf($subjectOf) + public function video($video) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('video', $video); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/Apartment.php b/src/Apartment.php index 62c0e0d64..bf3eee245 100644 --- a/src/Apartment.php +++ b/src/Apartment.php @@ -18,168 +18,104 @@ class Apartment extends BaseType implements AccommodationContract, PlaceContract, ThingContract { /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms - * - * @return static - * - * @see http://schema.org/numberOfRooms - */ - public function numberOfRooms($numberOfRooms) - { - return $this->setProperty('numberOfRooms', $numberOfRooms); - } - - /** - * The allowed total occupancy for the accommodation in persons (including - * infants etc). For individual accommodations, this is not necessarily the - * legal maximum but defines the permitted usage as per the contractual - * agreement (e.g. a double room used by a single person). - * Typical unit code(s): C62 for person - * - * @param QuantitativeValue|QuantitativeValue[] $occupancy - * - * @return static - * - * @see http://schema.org/occupancy - */ - public function occupancy($occupancy) - { - return $this->setProperty('occupancy', $occupancy); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard - * - * @param QuantitativeValue|QuantitativeValue[] $floorSize - * - * @return static - * - * @see http://schema.org/floorSize - */ - public function floorSize($floorSize) - { - return $this->setProperty('floorSize', $floorSize); - } - - /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/additionalProperty */ - public function numberOfRooms($numberOfRooms) + public function additionalProperty($additionalProperty) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Indications regarding the permitted usage of the accommodation. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $permittedUsage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/permittedUsage + * @see http://schema.org/additionalType */ - public function permittedUsage($permittedUsage) + public function additionalType($additionalType) { - return $this->setProperty('permittedUsage', $permittedUsage); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * Physical address of the item. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/address */ - public function petsAllowed($petsAllowed) + public function address($address) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('address', $address); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/aggregateRating */ - public function additionalProperty($additionalProperty) + public function aggregateRating($aggregateRating) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -245,6 +181,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -288,6 +255,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -333,6 +316,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -407,6 +423,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -450,320 +482,271 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. + * The name of the item. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess + * @param string|string[] $name * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/name */ - public function publicAccess($publicAccess) + public function name($name) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('name', $name); } /** - * A review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $review + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/review + * @see http://schema.org/numberOfRooms */ - public function review($review) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('review', $review); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * Review of the item. + * The allowed total occupancy for the accommodation in persons (including + * infants etc). For individual accommodations, this is not necessarily the + * legal maximum but defines the permitted usage as per the contractual + * agreement (e.g. a double room used by a single person). + * Typical unit code(s): C62 for person * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[] $occupancy * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/occupancy */ - public function reviews($reviews) + public function occupancy($occupancy) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('occupancy', $occupancy); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/ApartmentComplex.php b/src/ApartmentComplex.php index 8d5605a21..025ed57d0 100644 --- a/src/ApartmentComplex.php +++ b/src/ApartmentComplex.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/AppendAction.php b/src/AppendAction.php index c7847e125..b741a97bb 100644 --- a/src/AppendAction.php +++ b/src/AppendAction.php @@ -17,75 +17,110 @@ class AppendAction extends BaseType implements InsertActionContract, AddActionContract, UpdateActionContract, ActionContract, ThingContract { /** - * A sub property of location. The final location of the object or the agent - * after the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $toLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/actionStatus */ - public function toLocation($toLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of object. The collection target of the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $collection + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/collection + * @see http://schema.org/additionalType */ - public function collection($collection) + public function additionalType($additionalType) { - return $this->setProperty('collection', $collection); + return $this->setProperty('additionalType', $additionalType); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); } /** * A sub property of object. The collection target of the action. * - * @param Thing|Thing[] $targetCollection + * @param Thing|Thing[] $collection * * @return static * - * @see http://schema.org/targetCollection + * @see http://schema.org/collection */ - public function targetCollection($targetCollection) + public function collection($collection) { - return $this->setProperty('targetCollection', $targetCollection); + return $this->setProperty('collection', $collection); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -126,288 +161,253 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $object + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/object + * @see http://schema.org/identifier */ - public function object($object) + public function identifier($identifier) { - return $this->setProperty('object', $object); + return $this->setProperty('identifier', $identifier); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/image */ - public function participant($participant) + public function image($image) { - return $this->setProperty('participant', $participant); + return $this->setProperty('image', $image); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/result */ - public function identifier($identifier) + public function result($result) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('result', $result); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/startTime */ - public function mainEntityOfPage($mainEntityOfPage) + public function startTime($startTime) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('startTime', $startTime); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates a target EntryPoint for an Action. * - * @param Action|Action[] $potentialAction + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/target */ - public function potentialAction($potentialAction) + public function target($target) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('target', $target); } /** - * 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. + * A sub property of object. The collection target of the action. * - * @param string|string[] $sameAs + * @param Thing|Thing[] $targetCollection * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/targetCollection */ - public function sameAs($sameAs) + public function targetCollection($targetCollection) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('targetCollection', $targetCollection); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/ApplyAction.php b/src/ApplyAction.php index c25298085..e6a43ed51 100644 --- a/src/ApplyAction.php +++ b/src/ApplyAction.php @@ -35,340 +35,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Aquarium.php b/src/Aquarium.php index a05c88b56..59c4f0867 100644 --- a/src/Aquarium.php +++ b/src/Aquarium.php @@ -14,35 +14,6 @@ */ class Aquarium extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/ArriveAction.php b/src/ArriveAction.php index e2fa07c03..62dd4f1f4 100644 --- a/src/ArriveAction.php +++ b/src/ArriveAction.php @@ -16,62 +16,96 @@ class ArriveAction extends BaseType implements MoveActionContract, ActionContract, ThingContract { /** - * A sub property of location. The original location of the object or the - * agent before the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $fromLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/actionStatus */ - public function fromLocation($fromLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $toLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/additionalType */ - public function toLocation($toLocation) + public function additionalType($additionalType) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -112,288 +146,254 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Thing|Thing[] $object + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/object + * @see http://schema.org/fromLocation */ - public function object($object) + public function fromLocation($fromLocation) { - return $this->setProperty('object', $object); + return $this->setProperty('fromLocation', $fromLocation); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/ArtGallery.php b/src/ArtGallery.php index f6596eb32..405387313 100644 --- a/src/ArtGallery.php +++ b/src/ArtGallery.php @@ -17,126 +17,104 @@ class ArtGallery extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Article.php b/src/Article.php index abd51c991..31eed9996 100644 --- a/src/Article.php +++ b/src/Article.php @@ -18,131 +18,6 @@ */ class Article extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -287,6 +162,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -302,6 +196,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -316,6 +224,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -593,6 +530,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -818,6 +786,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1016,8 +1017,24 @@ public function mainEntity($mainEntity) } /** - * A material that something is made from, e.g. leather, wool, cotton, - * paper. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. * * @param Product|Product[]|string|string[] $material * @@ -1045,6 +1062,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1061,6 +1092,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1075,6 +1149,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1216,6 +1305,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1282,6 +1387,45 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + /** * 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 @@ -1298,6 +1442,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1419,6 +1577,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1448,204 +1620,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/AskAction.php b/src/AskAction.php index bb0a2b74b..9a670628a 100644 --- a/src/AskAction.php +++ b/src/AskAction.php @@ -20,106 +20,110 @@ class AskAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** - * A sub property of object. A question. + * The subject matter of the content. * - * @param Question|Question[] $question + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/question + * @see http://schema.org/about */ - public function question($question) + public function about($about) { - return $this->setProperty('question', $question); + return $this->setProperty('about', $about); } /** - * The subject matter of the content. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $about + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/about + * @see http://schema.org/actionStatus */ - public function about($about) + public function actionStatus($actionStatus) { - return $this->setProperty('about', $about); + return $this->setProperty('actionStatus', $actionStatus); } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[]|string|string[] $inLanguage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/additionalType */ - public function inLanguage($inLanguage) + public function additionalType($additionalType) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of instrument. The language used on this action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Language|Language[] $language + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/language + * @see http://schema.org/agent */ - public function language($language) + public function agent($agent) { - return $this->setProperty('language', $language); + return $this->setProperty('agent', $agent); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * An alias for the item. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/alternateName */ - public function recipient($recipient) + public function alternateName($alternateName) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -160,288 +164,284 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $instrument + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/identifier */ - public function instrument($instrument) + public function identifier($identifier) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Thing|Thing[] $object + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/object + * @see http://schema.org/inLanguage */ - public function object($object) + public function inLanguage($inLanguage) { - return $this->setProperty('object', $object); + return $this->setProperty('inLanguage', $inLanguage); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/instrument */ - public function participant($participant) + public function instrument($instrument) { - return $this->setProperty('participant', $participant); + return $this->setProperty('instrument', $instrument); } /** - * The result produced in the action. e.g. John wrote *a book*. + * A sub property of instrument. The language used on this action. * - * @param Thing|Thing[] $result + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/result + * @see http://schema.org/language */ - public function result($result) + public function language($language) { - return $this->setProperty('result', $result); + return $this->setProperty('language', $language); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of object. A question. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Question|Question[] $question * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/question */ - public function identifier($identifier) + public function question($question) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('question', $question); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/AssessAction.php b/src/AssessAction.php index ce80665eb..777771dca 100644 --- a/src/AssessAction.php +++ b/src/AssessAction.php @@ -28,340 +28,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/AssignAction.php b/src/AssignAction.php index bdc4f6f48..e2025e9ca 100644 --- a/src/AssignAction.php +++ b/src/AssignAction.php @@ -31,340 +31,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Attorney.php b/src/Attorney.php index e99ef0db3..5aebb97c8 100644 --- a/src/Attorney.php +++ b/src/Attorney.php @@ -20,126 +20,104 @@ class Attorney extends BaseType implements LegalServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -184,6 +162,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -227,6 +240,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -244,6 +322,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -430,22 +539,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -475,6 +612,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -491,6 +675,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -549,6 +748,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -563,6 +793,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -622,6 +894,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -650,6 +936,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -680,664 +1009,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Audience.php b/src/Audience.php index ff4b0f0c6..3bba7fa44 100644 --- a/src/Audience.php +++ b/src/Audience.php @@ -20,35 +20,6 @@ class Audience extends BaseType implements IntangibleContract, ThingContract */ const Researcher = 'http://schema.org/Researcher'; - /** - * The target group associated with a given audience (e.g. veterans, car - * owners, musicians, etc.). - * - * @param string|string[] $audienceType - * - * @return static - * - * @see http://schema.org/audienceType - */ - public function audienceType($audienceType) - { - return $this->setProperty('audienceType', $audienceType); - } - - /** - * The geographic area associated with the audience. - * - * @param AdministrativeArea|AdministrativeArea[] $geographicArea - * - * @return static - * - * @see http://schema.org/geographicArea - */ - public function geographicArea($geographicArea) - { - return $this->setProperty('geographicArea', $geographicArea); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -82,6 +53,21 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The target group associated with a given audience (e.g. veterans, car + * owners, musicians, etc.). + * + * @param string|string[] $audienceType + * + * @return static + * + * @see http://schema.org/audienceType + */ + public function audienceType($audienceType) + { + return $this->setProperty('audienceType', $audienceType); + } + /** * A description of the item. * @@ -113,6 +99,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides diff --git a/src/AudioObject.php b/src/AudioObject.php index eddbbc4d3..dd7aefaa2 100644 --- a/src/AudioObject.php +++ b/src/AudioObject.php @@ -14,315 +14,6 @@ */ class AudioObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { - /** - * The caption for this object. For downloadable machine formats (closed - * caption, subtitles etc.) use MediaObject and indicate the - * [[encodingFormat]]. - * - * @param MediaObject|MediaObject[]|string|string[] $caption - * - * @return static - * - * @see http://schema.org/caption - */ - public function caption($caption) - { - return $this->setProperty('caption', $caption); - } - - /** - * If this MediaObject is an AudioObject or VideoObject, the transcript of - * that object. - * - * @param string|string[] $transcript - * - * @return static - * - * @see http://schema.org/transcript - */ - public function transcript($transcript) - { - return $this->setProperty('transcript', $transcript); - } - - /** - * A NewsArticle associated with the Media Object. - * - * @param NewsArticle|NewsArticle[] $associatedArticle - * - * @return static - * - * @see http://schema.org/associatedArticle - */ - public function associatedArticle($associatedArticle) - { - return $this->setProperty('associatedArticle', $associatedArticle); - } - - /** - * The bitrate of the media object. - * - * @param string|string[] $bitrate - * - * @return static - * - * @see http://schema.org/bitrate - */ - public function bitrate($bitrate) - { - return $this->setProperty('bitrate', $bitrate); - } - - /** - * File size in (mega/kilo) bytes. - * - * @param string|string[] $contentSize - * - * @return static - * - * @see http://schema.org/contentSize - */ - public function contentSize($contentSize) - { - return $this->setProperty('contentSize', $contentSize); - } - - /** - * Actual bytes of the media object, for example the image file or video - * file. - * - * @param string|string[] $contentUrl - * - * @return static - * - * @see http://schema.org/contentUrl - */ - public function contentUrl($contentUrl) - { - return $this->setProperty('contentUrl', $contentUrl); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * A URL pointing to a player for a specific video. In general, this is the - * information in the ```src``` element of an ```embed``` tag and should not - * be the same as the content of the ```loc``` tag. - * - * @param string|string[] $embedUrl - * - * @return static - * - * @see http://schema.org/embedUrl - */ - public function embedUrl($embedUrl) - { - return $this->setProperty('embedUrl', $embedUrl); - } - - /** - * The CreativeWork encoded by this media object. - * - * @param CreativeWork|CreativeWork[] $encodesCreativeWork - * - * @return static - * - * @see http://schema.org/encodesCreativeWork - */ - public function encodesCreativeWork($encodesCreativeWork) - { - return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); - } - - /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside - * particular [[encodingFormat]] information. - * - * Unregistered or niche encoding and file formats can be indicated instead - * via the most appropriate URL, e.g. defining Web page or a - * Wikipedia/Wikidata entry. - * - * @param string|string[] $encodingFormat - * - * @return static - * - * @see http://schema.org/encodingFormat - */ - public function encodingFormat($encodingFormat) - { - return $this->setProperty('encodingFormat', $encodingFormat); - } - - /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime - * - * @return static - * - * @see http://schema.org/endTime - */ - public function endTime($endTime) - { - return $this->setProperty('endTime', $endTime); - } - - /** - * The height of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height - * - * @return static - * - * @see http://schema.org/height - */ - public function height($height) - { - return $this->setProperty('height', $height); - } - - /** - * Player type required—for example, Flash or Silverlight. - * - * @param string|string[] $playerType - * - * @return static - * - * @see http://schema.org/playerType - */ - public function playerType($playerType) - { - return $this->setProperty('playerType', $playerType); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The regions where the media is allowed. If not specified, then it's - * assumed to be allowed everywhere. Specify the countries in [ISO 3166 - * format](http://en.wikipedia.org/wiki/ISO_3166). - * - * @param Place|Place[] $regionsAllowed - * - * @return static - * - * @see http://schema.org/regionsAllowed - */ - public function regionsAllowed($regionsAllowed) - { - return $this->setProperty('regionsAllowed', $regionsAllowed); - } - - /** - * Indicates if use of the media require a subscription (either paid or - * free). Allowed values are ```true``` or ```false``` (note that an earlier - * version had 'yes', 'no'). - * - * @param bool|bool[] $requiresSubscription - * - * @return static - * - * @see http://schema.org/requiresSubscription - */ - public function requiresSubscription($requiresSubscription) - { - return $this->setProperty('requiresSubscription', $requiresSubscription); - } - - /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime - * - * @return static - * - * @see http://schema.org/startTime - */ - public function startTime($startTime) - { - return $this->setProperty('startTime', $startTime); - } - - /** - * Date when this media object was uploaded to this site. - * - * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate - * - * @return static - * - * @see http://schema.org/uploadDate - */ - public function uploadDate($uploadDate) - { - return $this->setProperty('uploadDate', $uploadDate); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - /** * The subject matter of the content. * @@ -467,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -482,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -496,6 +220,20 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -583,6 +321,36 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * The caption for this object. For downloadable machine formats (closed + * caption, subtitles etc.) use MediaObject and indicate the + * [[encodingFormat]]. + * + * @param MediaObject|MediaObject[]|string|string[] $caption + * + * @return static + * + * @see http://schema.org/caption + */ + public function caption($caption) + { + return $this->setProperty('caption', $caption); + } + /** * Fictional person connected with a creative work. * @@ -671,6 +439,35 @@ public function contentRating($contentRating) return $this->setProperty('contentRating', $contentRating); } + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + /** * A secondary contributor to the CreativeWork or Event. * @@ -773,6 +570,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -787,6 +615,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -812,22 +655,52 @@ public function editor($editor) */ public function educationalAlignment($educationalAlignment) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * The CreativeWork encoded by this media object. * - * @param string|string[] $educationalUse + * @param CreativeWork|CreativeWork[] $encodesCreativeWork * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/encodesCreativeWork */ - public function educationalUse($educationalUse) + public function encodesCreativeWork($encodesCreativeWork) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); } /** @@ -845,6 +718,33 @@ public function encoding($encoding) return $this->setProperty('encoding', $encoding); } + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + /** * A media object that encodes this CreativeWork. * @@ -859,6 +759,29 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -971,6 +894,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1168,6 +1138,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1198,6 +1184,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1214,6 +1214,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + /** * The position of an item in a series or sequence of items. * @@ -1228,6 +1242,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1243,6 +1272,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1326,6 +1370,22 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1341,6 +1401,22 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + /** * A review of the item. * @@ -1369,6 +1445,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1424,31 +1516,68 @@ public function spatial($spatial) * areas that the dataset describes: a dataset of New York weather * would have spatialCoverage which was the place: the state of New York. * - * @param Place|Place[] $spatialCoverage + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/startTime */ - public function spatialCoverage($spatialCoverage) + public function startTime($startTime) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/subjectOf */ - public function sponsor($sponsor) + public function subjectOf($subjectOf) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('subjectOf', $subjectOf); } /** @@ -1542,6 +1671,21 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * If this MediaObject is an AudioObject or VideoObject, the transcript of + * that object. + * + * @param string|string[] $transcript + * + * @return static + * + * @see http://schema.org/transcript + */ + public function transcript($transcript) + { + return $this->setProperty('transcript', $transcript); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1573,232 +1717,88 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Date when this media object was uploaded to this site. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/uploadDate */ - public function mainEntityOfPage($mainEntityOfPage) + public function uploadDate($uploadDate) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('uploadDate', $uploadDate); } /** - * The name of the item. + * URL of the item. * - * @param string|string[] $name + * @param string|string[] $url * * @return static * - * @see http://schema.org/name + * @see http://schema.org/url */ - public function name($name) + public function url($url) { - return $this->setProperty('name', $name); + return $this->setProperty('url', $url); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The version of the CreativeWork embodied by a specified resource. * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/version */ - public function potentialAction($potentialAction) + public function version($version) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('version', $version); } /** - * 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. + * An embedded video object. * - * @param string|string[] $sameAs + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/video */ - public function sameAs($sameAs) + public function video($video) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('video', $video); } /** - * A CreativeWork or Event about this Thing. + * The width of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/width */ - public function subjectOf($subjectOf) + public function width($width) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('width', $width); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/AuthorizeAction.php b/src/AuthorizeAction.php index 5f4f08a3e..9b6936421 100644 --- a/src/AuthorizeAction.php +++ b/src/AuthorizeAction.php @@ -16,32 +16,36 @@ class AuthorizeAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * Indicates the current disposition of the Action. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/actionStatus */ - public function recipient($recipient) + public function actionStatus($actionStatus) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -60,325 +64,321 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/AutoBodyShop.php b/src/AutoBodyShop.php index f5f63ac84..1d6fbee94 100644 --- a/src/AutoBodyShop.php +++ b/src/AutoBodyShop.php @@ -17,126 +17,104 @@ class AutoBodyShop extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AutoDealer.php b/src/AutoDealer.php index b7f70bd3e..fa9a854e2 100644 --- a/src/AutoDealer.php +++ b/src/AutoDealer.php @@ -17,126 +17,104 @@ class AutoDealer extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AutoPartsStore.php b/src/AutoPartsStore.php index 9f5fb05f9..d6c8dec5b 100644 --- a/src/AutoPartsStore.php +++ b/src/AutoPartsStore.php @@ -18,126 +18,104 @@ class AutoPartsStore extends BaseType implements AutomotiveBusinessContract, StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -182,6 +160,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -225,6 +238,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -242,6 +320,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -428,22 +537,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -473,6 +610,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -489,6 +673,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -547,6 +746,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -561,6 +791,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -620,6 +892,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -648,6 +934,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -678,664 +1007,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AutoRental.php b/src/AutoRental.php index 6cc3450ac..54cfedf72 100644 --- a/src/AutoRental.php +++ b/src/AutoRental.php @@ -17,126 +17,104 @@ class AutoRental extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AutoRepair.php b/src/AutoRepair.php index 50d16b64e..eb805cf13 100644 --- a/src/AutoRepair.php +++ b/src/AutoRepair.php @@ -17,126 +17,104 @@ class AutoRepair extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AutoWash.php b/src/AutoWash.php index ec33df8bf..d74d21d64 100644 --- a/src/AutoWash.php +++ b/src/AutoWash.php @@ -17,126 +17,104 @@ class AutoWash extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AutomatedTeller.php b/src/AutomatedTeller.php index 5426eaf52..8b420af49 100644 --- a/src/AutomatedTeller.php +++ b/src/AutomatedTeller.php @@ -17,183 +17,181 @@ class AutomatedTeller extends BaseType implements FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $feesAndCommissionsSpecification + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/additionalProperty */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function additionalProperty($additionalProperty) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/additionalType */ - public function branchOf($branchOf) + public function additionalType($additionalType) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Physical address of the item. * - * @param string|string[] $currenciesAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/address */ - public function currenciesAccepted($currenciesAccepted) + public function address($address) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('address', $address); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $openingHours + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/aggregateRating */ - public function openingHours($openingHours) + public function aggregateRating($aggregateRating) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * An alias for the item. * - * @param string|string[] $paymentAccepted + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/alternateName */ - public function paymentAccepted($paymentAccepted) + public function alternateName($alternateName) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('alternateName', $alternateName); } /** - * The price range of the business, for example ```$$$```. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $priceRange + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/amenityFeature */ - public function priceRange($priceRange) + public function amenityFeature($amenityFeature) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Physical address of the item. + * The geographic area where a service or offered item is provided. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/address + * @see http://schema.org/areaServed */ - public function address($address) + public function areaServed($areaServed) { - return $this->setProperty('address', $address); + return $this->setProperty('areaServed', $areaServed); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An award won by or for this item. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $award * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/award */ - public function aggregateRating($aggregateRating) + public function award($award) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('award', $award); } /** - * The geographic area where a service or offered item is provided. + * Awards won by or for this item. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param string|string[] $awards * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/awards */ - public function areaServed($areaServed) + public function awards($awards) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('awards', $awards); } /** - * An award won by or for this item. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param string|string[] $award + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/award + * @see http://schema.org/branchCode */ - public function award($award) + public function branchCode($branchCode) { - return $this->setProperty('award', $award); + return $this->setProperty('branchCode', $branchCode); } /** - * Awards won by or for this item. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $awards + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/branchOf */ - public function awards($awards) + public function branchOf($branchOf) { - return $this->setProperty('awards', $awards); + return $this->setProperty('branchOf', $branchOf); } /** @@ -239,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -256,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -370,6 +464,21 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + /** * A person who founded this organization. * @@ -441,6 +550,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -458,6 +581,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -487,6 +624,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -503,6 +687,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -561,6 +760,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -575,6 +805,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -634,6 +906,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -662,6 +948,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -692,664 +1021,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/photos */ - public function reviews($reviews) + public function photos($photos) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Demand|Demand[] $seeks + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/potentialAction */ - public function seeks($seeks) + public function potentialAction($potentialAction) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The geographic area where the service is provided. + * The price range of the business, for example ```$$$```. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/priceRange */ - public function serviceArea($serviceArea) + public function priceRange($priceRange) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('priceRange', $priceRange); } /** - * A slogan or motto associated with the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $slogan + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/publicAccess */ - public function slogan($slogan) + public function publicAccess($publicAccess) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/publishingPrinciples */ - public function sponsor($sponsor) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A review of the item. * - * @param Organization|Organization[] $subOrganization + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/review */ - public function subOrganization($subOrganization) + public function review($review) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('review', $review); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * Review of the item. * - * @param string|string[] $taxID + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/reviews */ - public function taxID($taxID) + public function reviews($reviews) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('reviews', $reviews); } /** - * The telephone number. + * 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. * - * @param string|string[] $telephone + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/sameAs */ - public function telephone($telephone) + public function sameAs($sameAs) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('sameAs', $sameAs); } /** - * The Value-added Tax ID of the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param string|string[] $vatID + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/seeks */ - public function vatID($vatID) + public function seeks($seeks) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('seeks', $seeks); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geographic area where the service is provided. * - * @param string|string[] $additionalType + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/serviceArea */ - public function additionalType($additionalType) + public function serviceArea($serviceArea) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('serviceArea', $serviceArea); } /** - * An alias for the item. + * A slogan or motto associated with the item. * - * @param string|string[] $alternateName + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/slogan */ - public function alternateName($alternateName) + public function slogan($slogan) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('slogan', $slogan); } /** - * A description of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $description + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/description + * @see http://schema.org/smokingAllowed */ - public function description($description) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('description', $description); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * 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. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $disambiguatingDescription + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/specialOpeningHoursSpecification */ - public function disambiguatingDescription($disambiguatingDescription) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sponsor */ - public function identifier($identifier) + public function sponsor($sponsor) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sponsor', $sponsor); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/image + * @see http://schema.org/subOrganization */ - public function image($image) + public function subOrganization($subOrganization) { - return $this->setProperty('image', $image); + return $this->setProperty('subOrganization', $subOrganization); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A CreativeWork or Event about this Thing. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/subjectOf */ - public function mainEntityOfPage($mainEntityOfPage) + public function subjectOf($subjectOf) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('subjectOf', $subjectOf); } /** - * The name of the item. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param string|string[] $name + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/name + * @see http://schema.org/taxID */ - public function name($name) + public function taxID($taxID) { - return $this->setProperty('name', $name); + return $this->setProperty('taxID', $taxID); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The telephone number. * - * @param Action|Action[] $potentialAction + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/telephone */ - public function potentialAction($potentialAction) + public function telephone($telephone) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('telephone', $telephone); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The Value-added Tax ID of the organization or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/vatID */ - public function subjectOf($subjectOf) + public function vatID($vatID) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty - * - * @return static - * - * @see http://schema.org/additionalProperty - */ - public function additionalProperty($additionalProperty) - { - return $this->setProperty('additionalProperty', $additionalProperty); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. - * - * @param string|string[] $branchCode - * - * @return static - * - * @see http://schema.org/branchCode - */ - public function branchCode($branchCode) - { - return $this->setProperty('branchCode', $branchCode); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedIn - * - * @return static - * - * @see http://schema.org/containedIn - */ - public function containedIn($containedIn) - { - return $this->setProperty('containedIn', $containedIn); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedInPlace - * - * @return static - * - * @see http://schema.org/containedInPlace - */ - public function containedInPlace($containedInPlace) - { - return $this->setProperty('containedInPlace', $containedInPlace); - } - - /** - * The basic containment relation between a place and another that it - * contains. - * - * @param Place|Place[] $containsPlace - * - * @return static - * - * @see http://schema.org/containsPlace - */ - public function containsPlace($containsPlace) - { - return $this->setProperty('containsPlace', $containsPlace); - } - - /** - * The geo coordinates of the place. - * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo - * - * @return static - * - * @see http://schema.org/geo - */ - public function geo($geo) - { - return $this->setProperty('geo', $geo); - } - - /** - * A URL to a map of the place. - * - * @param Map|Map[]|string|string[] $hasMap - * - * @return static - * - * @see http://schema.org/hasMap - */ - public function hasMap($hasMap) - { - return $this->setProperty('hasMap', $hasMap); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $latitude - * - * @return static - * - * @see http://schema.org/latitude - */ - public function latitude($latitude) - { - return $this->setProperty('latitude', $latitude); - } - - /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $longitude - * - * @return static - * - * @see http://schema.org/longitude - */ - public function longitude($longitude) - { - return $this->setProperty('longitude', $longitude); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $map - * - * @return static - * - * @see http://schema.org/map - */ - public function map($map) - { - return $this->setProperty('map', $map); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $maps - * - * @return static - * - * @see http://schema.org/maps - */ - public function maps($maps) - { - return $this->setProperty('maps', $maps); - } - - /** - * The total number of individuals that may attend an event or venue. - * - * @param int|int[] $maximumAttendeeCapacity - * - * @return static - * - * @see http://schema.org/maximumAttendeeCapacity - */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) - { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); - } - - /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. - * - * @param bool|bool[] $smokingAllowed - * - * @return static - * - * @see http://schema.org/smokingAllowed - */ - public function smokingAllowed($smokingAllowed) - { - return $this->setProperty('smokingAllowed', $smokingAllowed); - } - - /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification - * - * @return static - * - * @see http://schema.org/specialOpeningHoursSpecification - */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) - { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/AutomotiveBusiness.php b/src/AutomotiveBusiness.php index 493400eff..85feda9ec 100644 --- a/src/AutomotiveBusiness.php +++ b/src/AutomotiveBusiness.php @@ -16,126 +16,104 @@ class AutomotiveBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Bakery.php b/src/Bakery.php index 2e0bfa50c..bf435f423 100644 --- a/src/Bakery.php +++ b/src/Bakery.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/BankAccount.php b/src/BankAccount.php index 8e6a24de4..6a013b6a9 100644 --- a/src/BankAccount.php +++ b/src/BankAccount.php @@ -17,65 +17,68 @@ class BankAccount extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/additionalType */ - public function annualPercentageRate($annualPercentageRate) + public function additionalType($additionalType) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('additionalType', $additionalType); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/aggregateRating */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function aggregateRating($aggregateRating) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/alternateName */ - public function interestRate($interestRate) + public function alternateName($alternateName) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/annualPercentageRate */ - public function aggregateRating($aggregateRating) + public function annualPercentageRate($annualPercentageRate) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -183,380 +186,377 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * A description of the item. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/description */ - public function hasOfferCatalog($hasOfferCatalog) + public function description($description) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('description', $description); } /** - * The hours during which this service or contact is available. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/disambiguatingDescription */ - public function hoursAvailable($hoursAvailable) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, somehow related product (or multiple products). + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param string|string[] $feesAndCommissionsSpecification * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/feesAndCommissionsSpecification */ - public function isRelatedTo($isRelatedTo) + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/hasOfferCatalog */ - public function isSimilarTo($isSimilarTo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An associated logo. + * The hours during which this service or contact is available. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hoursAvailable */ - public function logo($logo) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $offers + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/identifier */ - public function offers($offers) + public function identifier($identifier) { - return $this->setProperty('offers', $offers); + return $this->setProperty('identifier', $identifier); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $produces + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/image */ - public function produces($produces) + public function image($image) { - return $this->setProperty('produces', $produces); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/interestRate */ - public function provider($provider) + public function interestRate($interestRate) { - return $this->setProperty('provider', $provider); + return $this->setProperty('interestRate', $interestRate); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * A pointer to another, somehow related product (or multiple products). * - * @param string|string[] $providerMobility + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/isRelatedTo */ - public function providerMobility($providerMobility) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * A review of the item. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param Review|Review[] $review + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/isSimilarTo */ - public function review($review) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('review', $review); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * The geographic area where the service is provided. + * An associated logo. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/logo */ - public function serviceArea($serviceArea) + public function logo($logo) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('logo', $logo); } /** - * The audience eligible for this service. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Audience|Audience[] $serviceAudience + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/mainEntityOfPage */ - public function serviceAudience($serviceAudience) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * The name of the item. * - * @param Thing|Thing[] $serviceOutput + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/name */ - public function serviceOutput($serviceOutput) + public function name($name) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('name', $name); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param string|string[] $serviceType + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/offers */ - public function serviceType($serviceType) + public function offers($offers) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('offers', $offers); } /** - * A slogan or motto associated with the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $slogan + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/potentialAction */ - public function slogan($slogan) + public function potentialAction($potentialAction) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/produces */ - public function additionalType($additionalType) + public function produces($produces) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('produces', $produces); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $description + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/description + * @see http://schema.org/providerMobility */ - public function description($description) + public function providerMobility($providerMobility) { - return $this->setProperty('description', $description); + return $this->setProperty('providerMobility', $providerMobility); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** diff --git a/src/BankOrCreditUnion.php b/src/BankOrCreditUnion.php index b1e6be8fd..0ece10f3a 100644 --- a/src/BankOrCreditUnion.php +++ b/src/BankOrCreditUnion.php @@ -17,183 +17,181 @@ class BankOrCreditUnion extends BaseType implements FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $feesAndCommissionsSpecification + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/additionalProperty */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function additionalProperty($additionalProperty) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/additionalType */ - public function branchOf($branchOf) + public function additionalType($additionalType) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Physical address of the item. * - * @param string|string[] $currenciesAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/address */ - public function currenciesAccepted($currenciesAccepted) + public function address($address) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('address', $address); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $openingHours + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/aggregateRating */ - public function openingHours($openingHours) + public function aggregateRating($aggregateRating) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * An alias for the item. * - * @param string|string[] $paymentAccepted + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/alternateName */ - public function paymentAccepted($paymentAccepted) + public function alternateName($alternateName) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('alternateName', $alternateName); } /** - * The price range of the business, for example ```$$$```. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $priceRange + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/amenityFeature */ - public function priceRange($priceRange) + public function amenityFeature($amenityFeature) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Physical address of the item. + * The geographic area where a service or offered item is provided. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/address + * @see http://schema.org/areaServed */ - public function address($address) + public function areaServed($areaServed) { - return $this->setProperty('address', $address); + return $this->setProperty('areaServed', $areaServed); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An award won by or for this item. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $award * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/award */ - public function aggregateRating($aggregateRating) + public function award($award) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('award', $award); } /** - * The geographic area where a service or offered item is provided. + * Awards won by or for this item. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param string|string[] $awards * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/awards */ - public function areaServed($areaServed) + public function awards($awards) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('awards', $awards); } /** - * An award won by or for this item. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param string|string[] $award + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/award + * @see http://schema.org/branchCode */ - public function award($award) + public function branchCode($branchCode) { - return $this->setProperty('award', $award); + return $this->setProperty('branchCode', $branchCode); } /** - * Awards won by or for this item. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $awards + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/branchOf */ - public function awards($awards) + public function branchOf($branchOf) { - return $this->setProperty('awards', $awards); + return $this->setProperty('branchOf', $branchOf); } /** @@ -239,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -256,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -370,6 +464,21 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + /** * A person who founded this organization. * @@ -441,6 +550,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -458,6 +581,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -487,6 +624,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -503,6 +687,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -561,6 +760,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -575,6 +805,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -634,6 +906,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -662,6 +948,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -692,664 +1021,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/photos */ - public function reviews($reviews) + public function photos($photos) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Demand|Demand[] $seeks + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/potentialAction */ - public function seeks($seeks) + public function potentialAction($potentialAction) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The geographic area where the service is provided. + * The price range of the business, for example ```$$$```. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/priceRange */ - public function serviceArea($serviceArea) + public function priceRange($priceRange) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('priceRange', $priceRange); } /** - * A slogan or motto associated with the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $slogan + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/publicAccess */ - public function slogan($slogan) + public function publicAccess($publicAccess) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/publishingPrinciples */ - public function sponsor($sponsor) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A review of the item. * - * @param Organization|Organization[] $subOrganization + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/review */ - public function subOrganization($subOrganization) + public function review($review) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('review', $review); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * Review of the item. * - * @param string|string[] $taxID + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/reviews */ - public function taxID($taxID) + public function reviews($reviews) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('reviews', $reviews); } /** - * The telephone number. + * 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. * - * @param string|string[] $telephone + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/sameAs */ - public function telephone($telephone) + public function sameAs($sameAs) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('sameAs', $sameAs); } /** - * The Value-added Tax ID of the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param string|string[] $vatID + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/seeks */ - public function vatID($vatID) + public function seeks($seeks) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('seeks', $seeks); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geographic area where the service is provided. * - * @param string|string[] $additionalType + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/serviceArea */ - public function additionalType($additionalType) + public function serviceArea($serviceArea) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('serviceArea', $serviceArea); } /** - * An alias for the item. + * A slogan or motto associated with the item. * - * @param string|string[] $alternateName + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/slogan */ - public function alternateName($alternateName) + public function slogan($slogan) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('slogan', $slogan); } /** - * A description of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $description + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/description + * @see http://schema.org/smokingAllowed */ - public function description($description) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('description', $description); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * 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. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $disambiguatingDescription + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/specialOpeningHoursSpecification */ - public function disambiguatingDescription($disambiguatingDescription) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sponsor */ - public function identifier($identifier) + public function sponsor($sponsor) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sponsor', $sponsor); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/image + * @see http://schema.org/subOrganization */ - public function image($image) + public function subOrganization($subOrganization) { - return $this->setProperty('image', $image); + return $this->setProperty('subOrganization', $subOrganization); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A CreativeWork or Event about this Thing. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/subjectOf */ - public function mainEntityOfPage($mainEntityOfPage) + public function subjectOf($subjectOf) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('subjectOf', $subjectOf); } /** - * The name of the item. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param string|string[] $name + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/name + * @see http://schema.org/taxID */ - public function name($name) + public function taxID($taxID) { - return $this->setProperty('name', $name); + return $this->setProperty('taxID', $taxID); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The telephone number. * - * @param Action|Action[] $potentialAction + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/telephone */ - public function potentialAction($potentialAction) + public function telephone($telephone) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('telephone', $telephone); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The Value-added Tax ID of the organization or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/vatID */ - public function subjectOf($subjectOf) + public function vatID($vatID) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty - * - * @return static - * - * @see http://schema.org/additionalProperty - */ - public function additionalProperty($additionalProperty) - { - return $this->setProperty('additionalProperty', $additionalProperty); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. - * - * @param string|string[] $branchCode - * - * @return static - * - * @see http://schema.org/branchCode - */ - public function branchCode($branchCode) - { - return $this->setProperty('branchCode', $branchCode); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedIn - * - * @return static - * - * @see http://schema.org/containedIn - */ - public function containedIn($containedIn) - { - return $this->setProperty('containedIn', $containedIn); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedInPlace - * - * @return static - * - * @see http://schema.org/containedInPlace - */ - public function containedInPlace($containedInPlace) - { - return $this->setProperty('containedInPlace', $containedInPlace); - } - - /** - * The basic containment relation between a place and another that it - * contains. - * - * @param Place|Place[] $containsPlace - * - * @return static - * - * @see http://schema.org/containsPlace - */ - public function containsPlace($containsPlace) - { - return $this->setProperty('containsPlace', $containsPlace); - } - - /** - * The geo coordinates of the place. - * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo - * - * @return static - * - * @see http://schema.org/geo - */ - public function geo($geo) - { - return $this->setProperty('geo', $geo); - } - - /** - * A URL to a map of the place. - * - * @param Map|Map[]|string|string[] $hasMap - * - * @return static - * - * @see http://schema.org/hasMap - */ - public function hasMap($hasMap) - { - return $this->setProperty('hasMap', $hasMap); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $latitude - * - * @return static - * - * @see http://schema.org/latitude - */ - public function latitude($latitude) - { - return $this->setProperty('latitude', $latitude); - } - - /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $longitude - * - * @return static - * - * @see http://schema.org/longitude - */ - public function longitude($longitude) - { - return $this->setProperty('longitude', $longitude); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $map - * - * @return static - * - * @see http://schema.org/map - */ - public function map($map) - { - return $this->setProperty('map', $map); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $maps - * - * @return static - * - * @see http://schema.org/maps - */ - public function maps($maps) - { - return $this->setProperty('maps', $maps); - } - - /** - * The total number of individuals that may attend an event or venue. - * - * @param int|int[] $maximumAttendeeCapacity - * - * @return static - * - * @see http://schema.org/maximumAttendeeCapacity - */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) - { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); - } - - /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. - * - * @param bool|bool[] $smokingAllowed - * - * @return static - * - * @see http://schema.org/smokingAllowed - */ - public function smokingAllowed($smokingAllowed) - { - return $this->setProperty('smokingAllowed', $smokingAllowed); - } - - /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification - * - * @return static - * - * @see http://schema.org/specialOpeningHoursSpecification - */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) - { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/BarOrPub.php b/src/BarOrPub.php index b69ea1bbf..a3da10794 100644 --- a/src/BarOrPub.php +++ b/src/BarOrPub.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Barcode.php b/src/Barcode.php index e79e0d08e..e5318b856 100644 --- a/src/Barcode.php +++ b/src/Barcode.php @@ -15,343 +15,6 @@ */ class Barcode extends BaseType implements ImageObjectContract, MediaObjectContract, CreativeWorkContract, ThingContract { - /** - * The caption for this object. For downloadable machine formats (closed - * caption, subtitles etc.) use MediaObject and indicate the - * [[encodingFormat]]. - * - * @param MediaObject|MediaObject[]|string|string[] $caption - * - * @return static - * - * @see http://schema.org/caption - */ - public function caption($caption) - { - return $this->setProperty('caption', $caption); - } - - /** - * exif data for this object. - * - * @param PropertyValue|PropertyValue[]|string|string[] $exifData - * - * @return static - * - * @see http://schema.org/exifData - */ - public function exifData($exifData) - { - return $this->setProperty('exifData', $exifData); - } - - /** - * Indicates whether this image is representative of the content of the - * page. - * - * @param bool|bool[] $representativeOfPage - * - * @return static - * - * @see http://schema.org/representativeOfPage - */ - public function representativeOfPage($representativeOfPage) - { - return $this->setProperty('representativeOfPage', $representativeOfPage); - } - - /** - * Thumbnail image for an image or video. - * - * @param ImageObject|ImageObject[] $thumbnail - * - * @return static - * - * @see http://schema.org/thumbnail - */ - public function thumbnail($thumbnail) - { - return $this->setProperty('thumbnail', $thumbnail); - } - - /** - * A NewsArticle associated with the Media Object. - * - * @param NewsArticle|NewsArticle[] $associatedArticle - * - * @return static - * - * @see http://schema.org/associatedArticle - */ - public function associatedArticle($associatedArticle) - { - return $this->setProperty('associatedArticle', $associatedArticle); - } - - /** - * The bitrate of the media object. - * - * @param string|string[] $bitrate - * - * @return static - * - * @see http://schema.org/bitrate - */ - public function bitrate($bitrate) - { - return $this->setProperty('bitrate', $bitrate); - } - - /** - * File size in (mega/kilo) bytes. - * - * @param string|string[] $contentSize - * - * @return static - * - * @see http://schema.org/contentSize - */ - public function contentSize($contentSize) - { - return $this->setProperty('contentSize', $contentSize); - } - - /** - * Actual bytes of the media object, for example the image file or video - * file. - * - * @param string|string[] $contentUrl - * - * @return static - * - * @see http://schema.org/contentUrl - */ - public function contentUrl($contentUrl) - { - return $this->setProperty('contentUrl', $contentUrl); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * A URL pointing to a player for a specific video. In general, this is the - * information in the ```src``` element of an ```embed``` tag and should not - * be the same as the content of the ```loc``` tag. - * - * @param string|string[] $embedUrl - * - * @return static - * - * @see http://schema.org/embedUrl - */ - public function embedUrl($embedUrl) - { - return $this->setProperty('embedUrl', $embedUrl); - } - - /** - * The CreativeWork encoded by this media object. - * - * @param CreativeWork|CreativeWork[] $encodesCreativeWork - * - * @return static - * - * @see http://schema.org/encodesCreativeWork - */ - public function encodesCreativeWork($encodesCreativeWork) - { - return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); - } - - /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside - * particular [[encodingFormat]] information. - * - * Unregistered or niche encoding and file formats can be indicated instead - * via the most appropriate URL, e.g. defining Web page or a - * Wikipedia/Wikidata entry. - * - * @param string|string[] $encodingFormat - * - * @return static - * - * @see http://schema.org/encodingFormat - */ - public function encodingFormat($encodingFormat) - { - return $this->setProperty('encodingFormat', $encodingFormat); - } - - /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime - * - * @return static - * - * @see http://schema.org/endTime - */ - public function endTime($endTime) - { - return $this->setProperty('endTime', $endTime); - } - - /** - * The height of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height - * - * @return static - * - * @see http://schema.org/height - */ - public function height($height) - { - return $this->setProperty('height', $height); - } - - /** - * Player type required—for example, Flash or Silverlight. - * - * @param string|string[] $playerType - * - * @return static - * - * @see http://schema.org/playerType - */ - public function playerType($playerType) - { - return $this->setProperty('playerType', $playerType); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The regions where the media is allowed. If not specified, then it's - * assumed to be allowed everywhere. Specify the countries in [ISO 3166 - * format](http://en.wikipedia.org/wiki/ISO_3166). - * - * @param Place|Place[] $regionsAllowed - * - * @return static - * - * @see http://schema.org/regionsAllowed - */ - public function regionsAllowed($regionsAllowed) - { - return $this->setProperty('regionsAllowed', $regionsAllowed); - } - - /** - * Indicates if use of the media require a subscription (either paid or - * free). Allowed values are ```true``` or ```false``` (note that an earlier - * version had 'yes', 'no'). - * - * @param bool|bool[] $requiresSubscription - * - * @return static - * - * @see http://schema.org/requiresSubscription - */ - public function requiresSubscription($requiresSubscription) - { - return $this->setProperty('requiresSubscription', $requiresSubscription); - } - - /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime - * - * @return static - * - * @see http://schema.org/startTime - */ - public function startTime($startTime) - { - return $this->setProperty('startTime', $startTime); - } - - /** - * Date when this media object was uploaded to this site. - * - * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate - * - * @return static - * - * @see http://schema.org/uploadDate - */ - public function uploadDate($uploadDate) - { - return $this->setProperty('uploadDate', $uploadDate); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - /** * The subject matter of the content. * @@ -496,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -511,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -525,6 +221,20 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -612,6 +322,36 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * The caption for this object. For downloadable machine formats (closed + * caption, subtitles etc.) use MediaObject and indicate the + * [[encodingFormat]]. + * + * @param MediaObject|MediaObject[]|string|string[] $caption + * + * @return static + * + * @see http://schema.org/caption + */ + public function caption($caption) + { + return $this->setProperty('caption', $caption); + } + /** * Fictional person connected with a creative work. * @@ -700,6 +440,35 @@ public function contentRating($contentRating) return $this->setProperty('contentRating', $contentRating); } + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + /** * A secondary contributor to the CreativeWork or Event. * @@ -802,6 +571,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -816,6 +616,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -859,6 +674,36 @@ public function educationalUse($educationalUse) return $this->setProperty('educationalUse', $educationalUse); } + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for associatedMedia. @@ -874,6 +719,33 @@ public function encoding($encoding) return $this->setProperty('encoding', $encoding); } + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + /** * A media object that encodes this CreativeWork. * @@ -888,6 +760,29 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -903,6 +798,20 @@ public function exampleOfWork($exampleOfWork) return $this->setProperty('exampleOfWork', $exampleOfWork); } + /** + * exif data for this object. + * + * @param PropertyValue|PropertyValue[]|string|string[] $exifData + * + * @return static + * + * @see http://schema.org/exifData + */ + public function exifData($exifData) + { + return $this->setProperty('exifData', $exifData); + } + /** * Date the content expires and is no longer useful or available. For * example a [[VideoObject]] or [[NewsArticle]] whose availability or @@ -1000,6 +909,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1197,6 +1153,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1227,6 +1199,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1243,6 +1229,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + /** * The position of an item in a series or sequence of items. * @@ -1257,6 +1257,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1272,6 +1287,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1355,6 +1385,22 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1370,6 +1416,37 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Indicates whether this image is representative of the content of the + * page. + * + * @param bool|bool[] $representativeOfPage + * + * @return static + * + * @see http://schema.org/representativeOfPage + */ + public function representativeOfPage($representativeOfPage) + { + return $this->setProperty('representativeOfPage', $representativeOfPage); + } + + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + /** * A review of the item. * @@ -1398,6 +1475,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1446,38 +1539,75 @@ public function spatial($spatial) } /** - * The spatialCoverage of a CreativeWork indicates the place(s) which are - * the focus of the content. It is a subproperty of - * contentLocation intended primarily for more technical and detailed - * materials. For example with a Dataset, it indicates - * areas that the dataset describes: a dataset of New York weather - * would have spatialCoverage which was the place: the state of New York. + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[] $spatialCoverage + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/startTime */ - public function spatialCoverage($spatialCoverage) + public function startTime($startTime) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/subjectOf */ - public function sponsor($sponsor) + public function subjectOf($subjectOf) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('subjectOf', $subjectOf); } /** @@ -1541,6 +1671,20 @@ public function text($text) return $this->setProperty('text', $text); } + /** + * Thumbnail image for an image or video. + * + * @param ImageObject|ImageObject[] $thumbnail + * + * @return static + * + * @see http://schema.org/thumbnail + */ + public function thumbnail($thumbnail) + { + return $this->setProperty('thumbnail', $thumbnail); + } + /** * A thumbnail image relevant to the Thing. * @@ -1602,232 +1746,88 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Date when this media object was uploaded to this site. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/uploadDate */ - public function mainEntityOfPage($mainEntityOfPage) + public function uploadDate($uploadDate) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('uploadDate', $uploadDate); } /** - * The name of the item. + * URL of the item. * - * @param string|string[] $name + * @param string|string[] $url * * @return static * - * @see http://schema.org/name + * @see http://schema.org/url */ - public function name($name) + public function url($url) { - return $this->setProperty('name', $name); + return $this->setProperty('url', $url); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The version of the CreativeWork embodied by a specified resource. * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/version */ - public function potentialAction($potentialAction) + public function version($version) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('version', $version); } /** - * 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. + * An embedded video object. * - * @param string|string[] $sameAs + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/video */ - public function sameAs($sameAs) + public function video($video) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('video', $video); } /** - * A CreativeWork or Event about this Thing. + * The width of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/width */ - public function subjectOf($subjectOf) + public function width($width) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('width', $width); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/Beach.php b/src/Beach.php index ba7d9a5ce..50941d155 100644 --- a/src/Beach.php +++ b/src/Beach.php @@ -14,35 +14,6 @@ */ class Beach extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/BeautySalon.php b/src/BeautySalon.php index 5bfd94d17..f9984e56b 100644 --- a/src/BeautySalon.php +++ b/src/BeautySalon.php @@ -17,126 +17,104 @@ class BeautySalon extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/BedAndBreakfast.php b/src/BedAndBreakfast.php index 6b42a3150..55d979a08 100644 --- a/src/BedAndBreakfast.php +++ b/src/BedAndBreakfast.php @@ -20,352 +20,395 @@ class BedAndBreakfast extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/additionalProperty */ - public function amenityFeature($amenityFeature) + public function additionalProperty($additionalProperty) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * An intended audience, i.e. a group for whom something was created. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Audience|Audience[] $audience + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/additionalType */ - public function audience($audience) + public function additionalType($additionalType) { - return $this->setProperty('audience', $audience); + return $this->setProperty('additionalType', $additionalType); } /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * Physical address of the item. * - * @param Language|Language[]|string|string[] $availableLanguage + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/availableLanguage + * @see http://schema.org/address */ - public function availableLanguage($availableLanguage) + public function address($address) { - return $this->setProperty('availableLanguage', $availableLanguage); + return $this->setProperty('address', $address); } /** - * The earliest someone may check into a lodging establishment. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/checkinTime + * @see http://schema.org/aggregateRating */ - public function checkinTime($checkinTime) + public function aggregateRating($aggregateRating) { - return $this->setProperty('checkinTime', $checkinTime); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The latest someone may check out of a lodging establishment. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/checkoutTime + * @see http://schema.org/alternateName */ - public function checkoutTime($checkoutTime) + public function alternateName($alternateName) { - return $this->setProperty('checkoutTime', $checkoutTime); + return $this->setProperty('alternateName', $alternateName); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/amenityFeature */ - public function numberOfRooms($numberOfRooms) + public function amenityFeature($amenityFeature) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * The geographic area where a service or offered item is provided. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/areaServed */ - public function petsAllowed($petsAllowed) + public function areaServed($areaServed) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('areaServed', $areaServed); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * An intended audience, i.e. a group for whom something was created. * - * @param Rating|Rating[] $starRating + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/audience */ - public function starRating($starRating) + public function audience($audience) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('audience', $audience); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] * - * @param Organization|Organization[] $branchOf + * @param Language|Language[]|string|string[] $availableLanguage * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/availableLanguage */ - public function branchOf($branchOf) + public function availableLanguage($availableLanguage) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('availableLanguage', $availableLanguage); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An award won by or for this item. * - * @param string|string[] $currenciesAccepted + * @param string|string[] $award * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/award */ - public function currenciesAccepted($currenciesAccepted) + public function award($award) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('award', $award); } /** - * 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 '-'. + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * The earliest someone may check into a lodging establishment. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime * * @return static * - * @see http://schema.org/address + * @see http://schema.org/checkinTime */ - public function address($address) + public function checkinTime($checkinTime) { - return $this->setProperty('address', $address); + return $this->setProperty('checkinTime', $checkinTime); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The latest someone may check out of a lodging establishment. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/checkoutTime */ - public function aggregateRating($aggregateRating) + public function checkoutTime($checkoutTime) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('checkoutTime', $checkoutTime); } /** - * The geographic area where a service or offered item is provided. + * A contact point for a person or organization. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/contactPoint */ - public function areaServed($areaServed) + public function contactPoint($contactPoint) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('contactPoint', $contactPoint); } /** - * An award won by or for this item. + * A contact point for a person or organization. * - * @param string|string[] $award + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/award + * @see http://schema.org/contactPoints */ - public function award($award) + public function contactPoints($contactPoints) { - return $this->setProperty('award', $award); + return $this->setProperty('contactPoints', $contactPoints); } /** - * Awards won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $awards + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containedIn */ - public function awards($awards) + public function containedIn($containedIn) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containedIn', $containedIn); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The basic containment relation between a place and one that contains it. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/containedInPlace */ - public function brand($brand) + public function containedInPlace($containedInPlace) { - return $this->setProperty('brand', $brand); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A contact point for a person or organization. + * The basic containment relation between a place and another that it + * contains. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -553,6 +596,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -570,6 +627,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -600,851 +671,780 @@ public function hasPOS($hasPOS) } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. - * - * @param string|string[] $isicV4 - * - * @return static - * - * @see http://schema.org/isicV4 - */ - public function isicV4($isicV4) - { - return $this->setProperty('isicV4', $isicV4); - } - - /** - * The official name of the organization, e.g. the registered company name. - * - * @param string|string[] $legalName - * - * @return static - * - * @see http://schema.org/legalName - */ - public function legalName($legalName) - { - return $this->setProperty('legalName', $legalName); - } - - /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. - * - * @param string|string[] $leiCode - * - * @return static - * - * @see http://schema.org/leiCode - */ - public function leiCode($leiCode) - { - return $this->setProperty('leiCode', $leiCode); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * An associated logo. - * - * @param ImageObject|ImageObject[]|string|string[] $logo - * - * @return static - * - * @see http://schema.org/logo - */ - public function logo($logo) - { - return $this->setProperty('logo', $logo); - } - - /** - * A pointer to products or services offered by the organization or person. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $makesOffer + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/identifier */ - public function makesOffer($makesOffer) + public function identifier($identifier) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('identifier', $identifier); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $member + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/member + * @see http://schema.org/image */ - public function member($member) + public function image($image) { - return $this->setProperty('member', $member); + return $this->setProperty('image', $image); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/isAccessibleForFree */ - public function memberOf($memberOf) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * A member of this organization. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param Organization|Organization[]|Person|Person[] $members + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isicV4 */ - public function members($members) + public function isicV4($isicV4) { - return $this->setProperty('members', $members); + return $this->setProperty('isicV4', $isicV4); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $naics + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/latitude */ - public function naics($naics) + public function latitude($latitude) { - return $this->setProperty('naics', $naics); + return $this->setProperty('latitude', $latitude); } /** - * The number of employees in an organization e.g. business. + * The official name of the organization, e.g. the registered company name. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/legalName */ - public function numberOfEmployees($numberOfEmployees) + public function legalName($legalName) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('legalName', $legalName); } /** - * A pointer to the organization or person making the offer. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/leiCode */ - public function offeredBy($offeredBy) + public function leiCode($leiCode) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('leiCode', $leiCode); } /** - * Products owned by the organization or person. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/location */ - public function owns($owns) + public function location($location) { - return $this->setProperty('owns', $owns); + return $this->setProperty('location', $location); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * An associated logo. * - * @param Organization|Organization[] $parentOrganization + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/logo */ - public function parentOrganization($parentOrganization) + public function logo($logo) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('logo', $logo); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/longitude */ - public function publishingPrinciples($publishingPrinciples) + public function longitude($longitude) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('longitude', $longitude); } /** - * A review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $review + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/review + * @see http://schema.org/mainEntityOfPage */ - public function review($review) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('review', $review); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Review of the item. + * A pointer to products or services offered by the organization or person. * - * @param Review|Review[] $reviews + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/makesOffer */ - public function reviews($reviews) + public function makesOffer($makesOffer) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A URL to a map of the place. * - * @param Demand|Demand[] $seeks + * @param string|string[] $map * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/map */ - public function seeks($seeks) + public function map($map) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('map', $map); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $maps * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/maps */ - public function serviceArea($serviceArea) + public function maps($maps) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('maps', $maps); } /** - * A slogan or motto associated with the item. + * The total number of individuals that may attend an event or venue. * - * @param string|string[] $slogan + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maximumAttendeeCapacity */ - public function slogan($slogan) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * 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. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/member */ - public function sponsor($sponsor) + public function member($member) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('member', $member); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/memberOf */ - public function subOrganization($subOrganization) + public function memberOf($memberOf) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('memberOf', $memberOf); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * A member of this organization. * - * @param string|string[] $taxID + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/members */ - public function taxID($taxID) + public function members($members) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('members', $members); } /** - * The telephone number. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $telephone + * @param string|string[] $naics * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/naics */ - public function telephone($telephone) + public function naics($naics) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('naics', $naics); } /** - * The Value-added Tax ID of the organization or person. + * The name of the item. * - * @param string|string[] $vatID + * @param string|string[] $name * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/name */ - public function vatID($vatID) + public function name($name) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The number of employees in an organization e.g. business. * - * @param string|string[] $additionalType + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/numberOfEmployees */ - public function additionalType($additionalType) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * An alias for the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param string|string[] $alternateName + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/numberOfRooms */ - public function alternateName($alternateName) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A description of the item. + * A pointer to the organization or person making the offer. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/description + * @see http://schema.org/offeredBy */ - public function description($description) + public function offeredBy($offeredBy) { - return $this->setProperty('description', $description); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/openingHours */ - public function disambiguatingDescription($disambiguatingDescription) + public function openingHours($openingHours) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('openingHours', $openingHours); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The opening hours of a certain place. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHoursSpecification */ - public function identifier($identifier) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Products owned by the organization or person. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/image + * @see http://schema.org/owns */ - public function image($image) + public function owns($owns) { - return $this->setProperty('image', $image); + return $this->setProperty('owns', $owns); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/parentOrganization */ - public function mainEntityOfPage($mainEntityOfPage) + public function parentOrganization($parentOrganization) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The name of the item. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $name + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/name + * @see http://schema.org/paymentAccepted */ - public function name($name) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('name', $name); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param Action|Action[] $potentialAction + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/petsAllowed */ - public function potentialAction($potentialAction) + public function petsAllowed($petsAllowed) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $branchCode + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publicAccess */ - public function branchCode($branchCode) + public function publicAccess($publicAccess) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedIn + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publishingPrinciples */ - public function containedIn($containedIn) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/review */ - public function containedInPlace($containedInPlace) + public function review($review) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and another that it - * contains. + * Review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/reviews */ - public function containsPlace($containsPlace) + public function reviews($reviews) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('reviews', $reviews); } /** - * The geo coordinates of the place. + * 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. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/sameAs */ - public function geo($geo) + public function sameAs($sameAs) { - return $this->setProperty('geo', $geo); + return $this->setProperty('sameAs', $sameAs); } /** - * A URL to a map of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param Map|Map[]|string|string[] $hasMap + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/seeks */ - public function hasMap($hasMap) + public function seeks($seeks) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('seeks', $seeks); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/BedDetails.php b/src/BedDetails.php index f9beb1746..e27174d7f 100644 --- a/src/BedDetails.php +++ b/src/BedDetails.php @@ -16,36 +16,6 @@ */ class BedDetails extends BaseType implements IntangibleContract, ThingContract { - /** - * The quantity of the given bed type available in the HotelRoom, Suite, - * House, or Apartment. - * - * @param float|float[]|int|int[] $numberOfBeds - * - * @return static - * - * @see http://schema.org/numberOfBeds - */ - public function numberOfBeds($numberOfBeds) - { - return $this->setProperty('numberOfBeds', $numberOfBeds); - } - - /** - * The type of bed to which the BedDetail refers, i.e. the type of bed - * available in the quantity indicated by quantity. - * - * @param string|string[] $typeOfBed - * - * @return static - * - * @see http://schema.org/typeOfBed - */ - public function typeOfBed($typeOfBed) - { - return $this->setProperty('typeOfBed', $typeOfBed); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -173,6 +143,21 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The quantity of the given bed type available in the HotelRoom, Suite, + * House, or Apartment. + * + * @param float|float[]|int|int[] $numberOfBeds + * + * @return static + * + * @see http://schema.org/numberOfBeds + */ + public function numberOfBeds($numberOfBeds) + { + return $this->setProperty('numberOfBeds', $numberOfBeds); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -218,6 +203,21 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The type of bed to which the BedDetail refers, i.e. the type of bed + * available in the quantity indicated by quantity. + * + * @param string|string[] $typeOfBed + * + * @return static + * + * @see http://schema.org/typeOfBed + */ + public function typeOfBed($typeOfBed) + { + return $this->setProperty('typeOfBed', $typeOfBed); + } + /** * URL of the item. * diff --git a/src/BedType.php b/src/BedType.php index 2d91631fa..80dc699a5 100644 --- a/src/BedType.php +++ b/src/BedType.php @@ -39,205 +39,175 @@ public function additionalProperty($additionalProperty) } /** - * This ordering relation for qualitative values indicates that the subject - * is equal to the object. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QualitativeValue|QualitativeValue[] $equal + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/equal + * @see http://schema.org/additionalType */ - public function equal($equal) + public function additionalType($additionalType) { - return $this->setProperty('equal', $equal); + return $this->setProperty('additionalType', $additionalType); } /** - * This ordering relation for qualitative values indicates that the subject - * is greater than the object. + * An alias for the item. * - * @param QualitativeValue|QualitativeValue[] $greater + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/greater + * @see http://schema.org/alternateName */ - public function greater($greater) + public function alternateName($alternateName) { - return $this->setProperty('greater', $greater); + return $this->setProperty('alternateName', $alternateName); } /** - * This ordering relation for qualitative values indicates that the subject - * is greater than or equal to the object. + * A description of the item. * - * @param QualitativeValue|QualitativeValue[] $greaterOrEqual + * @param string|string[] $description * * @return static * - * @see http://schema.org/greaterOrEqual + * @see http://schema.org/description */ - public function greaterOrEqual($greaterOrEqual) + public function description($description) { - return $this->setProperty('greaterOrEqual', $greaterOrEqual); + return $this->setProperty('description', $description); } /** - * This ordering relation for qualitative values indicates that the subject - * is lesser than the object. + * 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. * - * @param QualitativeValue|QualitativeValue[] $lesser + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/lesser + * @see http://schema.org/disambiguatingDescription */ - public function lesser($lesser) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('lesser', $lesser); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** * This ordering relation for qualitative values indicates that the subject - * is lesser than or equal to the object. + * is equal to the object. * - * @param QualitativeValue|QualitativeValue[] $lesserOrEqual + * @param QualitativeValue|QualitativeValue[] $equal * * @return static * - * @see http://schema.org/lesserOrEqual + * @see http://schema.org/equal */ - public function lesserOrEqual($lesserOrEqual) + public function equal($equal) { - return $this->setProperty('lesserOrEqual', $lesserOrEqual); + return $this->setProperty('equal', $equal); } /** * This ordering relation for qualitative values indicates that the subject - * is not equal to the object. - * - * @param QualitativeValue|QualitativeValue[] $nonEqual - * - * @return static - * - * @see http://schema.org/nonEqual - */ - public function nonEqual($nonEqual) - { - return $this->setProperty('nonEqual', $nonEqual); - } - - /** - * A pointer to a secondary value that provides additional information on - * the original value, e.g. a reference temperature. - * - * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference - * - * @return static - * - * @see http://schema.org/valueReference - */ - public function valueReference($valueReference) - { - return $this->setProperty('valueReference', $valueReference); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * is greater than the object. * - * @param string|string[] $additionalType + * @param QualitativeValue|QualitativeValue[] $greater * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/greater */ - public function additionalType($additionalType) + public function greater($greater) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('greater', $greater); } /** - * An alias for the item. + * This ordering relation for qualitative values indicates that the subject + * is greater than or equal to the object. * - * @param string|string[] $alternateName + * @param QualitativeValue|QualitativeValue[] $greaterOrEqual * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/greaterOrEqual */ - public function alternateName($alternateName) + public function greaterOrEqual($greaterOrEqual) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('greaterOrEqual', $greaterOrEqual); } /** - * A description of the item. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $description + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/description + * @see http://schema.org/identifier */ - public function description($description) + public function identifier($identifier) { - return $this->setProperty('description', $description); + return $this->setProperty('identifier', $identifier); } /** - * 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. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $disambiguatingDescription + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/image */ - public function disambiguatingDescription($disambiguatingDescription) + public function image($image) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('image', $image); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * This ordering relation for qualitative values indicates that the subject + * is lesser than the object. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param QualitativeValue|QualitativeValue[] $lesser * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/lesser */ - public function identifier($identifier) + public function lesser($lesser) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('lesser', $lesser); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * This ordering relation for qualitative values indicates that the subject + * is lesser than or equal to the object. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param QualitativeValue|QualitativeValue[] $lesserOrEqual * * @return static * - * @see http://schema.org/image + * @see http://schema.org/lesserOrEqual */ - public function image($image) + public function lesserOrEqual($lesserOrEqual) { - return $this->setProperty('image', $image); + return $this->setProperty('lesserOrEqual', $lesserOrEqual); } /** @@ -270,6 +240,21 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * This ordering relation for qualitative values indicates that the subject + * is not equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $nonEqual + * + * @return static + * + * @see http://schema.org/nonEqual + */ + public function nonEqual($nonEqual) + { + return $this->setProperty('nonEqual', $nonEqual); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -329,4 +314,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + } diff --git a/src/BefriendAction.php b/src/BefriendAction.php index 4f218a823..e17e5971d 100644 --- a/src/BefriendAction.php +++ b/src/BefriendAction.php @@ -35,340 +35,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/BikeStore.php b/src/BikeStore.php index ac3c020b6..2ba08cf78 100644 --- a/src/BikeStore.php +++ b/src/BikeStore.php @@ -17,126 +17,104 @@ class BikeStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Blog.php b/src/Blog.php index 91b77824b..7c82ec377 100644 --- a/src/Blog.php +++ b/src/Blog.php @@ -13,50 +13,6 @@ */ class Blog extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A posting that is part of this blog. - * - * @param BlogPosting|BlogPosting[] $blogPost - * - * @return static - * - * @see http://schema.org/blogPost - */ - public function blogPost($blogPost) - { - return $this->setProperty('blogPost', $blogPost); - } - - /** - * The postings that are part of this blog. - * - * @param BlogPosting|BlogPosting[] $blogPosts - * - * @return static - * - * @see http://schema.org/blogPosts - */ - public function blogPosts($blogPosts) - { - return $this->setProperty('blogPosts', $blogPosts); - } - - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - /** * The subject matter of the content. * @@ -201,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -216,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -317,6 +306,34 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A posting that is part of this blog. + * + * @param BlogPosting|BlogPosting[] $blogPost + * + * @return static + * + * @see http://schema.org/blogPost + */ + public function blogPost($blogPost) + { + return $this->setProperty('blogPost', $blogPost); + } + + /** + * The postings that are part of this blog. + * + * @param BlogPosting|BlogPosting[] $blogPosts + * + * @return static + * + * @see http://schema.org/blogPosts + */ + public function blogPosts($blogPosts) + { + return $this->setProperty('blogPosts', $blogPosts); + } + /** * Fictional person connected with a creative work. * @@ -507,6 +524,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -732,6 +780,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -854,6 +935,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -929,6 +1026,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -959,6 +1072,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -989,6 +1116,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1130,6 +1272,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1212,6 +1370,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1333,6 +1505,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1376,190 +1562,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/BlogPosting.php b/src/BlogPosting.php index fe48135b1..21f793c34 100644 --- a/src/BlogPosting.php +++ b/src/BlogPosting.php @@ -15,146 +15,6 @@ */ class BlogPosting extends BaseType implements SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract { - /** - * A CreativeWork such as an image, video, or audio clip shared as part of - * this posting. - * - * @param CreativeWork|CreativeWork[] $sharedContent - * - * @return static - * - * @see http://schema.org/sharedContent - */ - public function sharedContent($sharedContent) - { - return $this->setProperty('sharedContent', $sharedContent); - } - - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -299,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -314,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -328,6 +221,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -605,6 +527,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -831,28 +784,61 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Language|Language[]|string|string[] $inLanguage + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/identifier */ - public function inLanguage($inLanguage) + public function identifier($identifier) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('identifier', $identifier); } /** - * The number of interactions for the CreativeWork using the WebSite or - * SoftwareApplication. The most specific child type of InteractionCounter - * should be used. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic * * @return static * @@ -1027,6 +1013,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1057,6 +1059,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1073,6 +1089,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1087,6 +1146,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1228,6 +1302,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1245,6 +1335,21 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A CreativeWork such as an image, video, or audio clip shared as part of + * this posting. + * + * @param CreativeWork|CreativeWork[] $sharedContent + * + * @return static + * + * @see http://schema.org/sharedContent + */ + public function sharedContent($sharedContent) + { + return $this->setProperty('sharedContent', $sharedContent); + } + /** * The Organization on whose behalf the creator was working. * @@ -1294,6 +1399,45 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + /** * 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 @@ -1310,6 +1454,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1431,6 +1589,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1460,204 +1632,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/BodyOfWater.php b/src/BodyOfWater.php index 86d415a09..7d9ec80f5 100644 --- a/src/BodyOfWater.php +++ b/src/BodyOfWater.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Book.php b/src/Book.php index 63b22aa87..0af354684 100644 --- a/src/Book.php +++ b/src/Book.php @@ -13,76 +13,6 @@ */ class Book extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The edition of the book. - * - * @param string|string[] $bookEdition - * - * @return static - * - * @see http://schema.org/bookEdition - */ - public function bookEdition($bookEdition) - { - return $this->setProperty('bookEdition', $bookEdition); - } - - /** - * The format of the book. - * - * @param BookFormatType|BookFormatType[] $bookFormat - * - * @return static - * - * @see http://schema.org/bookFormat - */ - public function bookFormat($bookFormat) - { - return $this->setProperty('bookFormat', $bookFormat); - } - - /** - * The illustrator of the book. - * - * @param Person|Person[] $illustrator - * - * @return static - * - * @see http://schema.org/illustrator - */ - public function illustrator($illustrator) - { - return $this->setProperty('illustrator', $illustrator); - } - - /** - * The ISBN of the book. - * - * @param string|string[] $isbn - * - * @return static - * - * @see http://schema.org/isbn - */ - public function isbn($isbn) - { - return $this->setProperty('isbn', $isbn); - } - - /** - * The number of pages in the book. - * - * @param int|int[] $numberOfPages - * - * @return static - * - * @see http://schema.org/numberOfPages - */ - public function numberOfPages($numberOfPages) - { - return $this->setProperty('numberOfPages', $numberOfPages); - } - /** * The subject matter of the content. * @@ -227,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -242,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -343,6 +306,34 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The edition of the book. + * + * @param string|string[] $bookEdition + * + * @return static + * + * @see http://schema.org/bookEdition + */ + public function bookEdition($bookEdition) + { + return $this->setProperty('bookEdition', $bookEdition); + } + + /** + * The format of the book. + * + * @param BookFormatType|BookFormatType[] $bookFormat + * + * @return static + * + * @see http://schema.org/bookFormat + */ + public function bookFormat($bookFormat) + { + return $this->setProperty('bookFormat', $bookFormat); + } + /** * Fictional person connected with a creative work. * @@ -533,6 +524,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -758,6 +780,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * The illustrator of the book. + * + * @param Person|Person[] $illustrator + * + * @return static + * + * @see http://schema.org/illustrator + */ + public function illustrator($illustrator) + { + return $this->setProperty('illustrator', $illustrator); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -880,6 +949,20 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The ISBN of the book. + * + * @param string|string[] $isbn + * + * @return static + * + * @see http://schema.org/isbn + */ + public function isbn($isbn) + { + return $this->setProperty('isbn', $isbn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -955,6 +1038,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -985,6 +1084,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of pages in the book. + * + * @param int|int[] $numberOfPages + * + * @return static + * + * @see http://schema.org/numberOfPages + */ + public function numberOfPages($numberOfPages) + { + return $this->setProperty('numberOfPages', $numberOfPages); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1015,6 +1142,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1156,6 +1298,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1238,6 +1396,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1359,6 +1531,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1402,190 +1588,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/BookSeries.php b/src/BookSeries.php index bc18937e3..18fd409dc 100644 --- a/src/BookSeries.php +++ b/src/BookSeries.php @@ -16,52 +16,6 @@ */ class BookSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - /** * The subject matter of the content. * @@ -206,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -221,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -512,6 +499,53 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -625,6 +659,21 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -737,6 +786,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -859,6 +941,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -934,6 +1032,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -964,6 +1078,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -994,6 +1122,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1135,6 +1278,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1217,6 +1376,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1338,6 +1526,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1381,206 +1583,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - } diff --git a/src/BookStore.php b/src/BookStore.php index a116027c2..88482d79b 100644 --- a/src/BookStore.php +++ b/src/BookStore.php @@ -17,126 +17,104 @@ class BookStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/BookmarkAction.php b/src/BookmarkAction.php index e1e06b3df..bd2a73253 100644 --- a/src/BookmarkAction.php +++ b/src/BookmarkAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/BorrowAction.php b/src/BorrowAction.php index af76d39e1..00cc6785c 100644 --- a/src/BorrowAction.php +++ b/src/BorrowAction.php @@ -20,77 +20,96 @@ class BorrowAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The person that lends the object being - * borrowed. + * Indicates the current disposition of the Action. * - * @param Organization|Organization[]|Person|Person[] $lender + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/lender + * @see http://schema.org/actionStatus */ - public function lender($lender) + public function actionStatus($actionStatus) { - return $this->setProperty('lender', $lender); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The original location of the object or the - * agent before the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $fromLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/additionalType */ - public function fromLocation($fromLocation) + public function additionalType($additionalType) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Place|Place[] $toLocation + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/agent */ - public function toLocation($toLocation) + public function agent($agent) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -131,288 +150,269 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/location + * @see http://schema.org/fromLocation */ - public function location($location) + public function fromLocation($fromLocation) { - return $this->setProperty('location', $location); + return $this->setProperty('fromLocation', $fromLocation); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $object + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/object + * @see http://schema.org/identifier */ - public function object($object) + public function identifier($identifier) { - return $this->setProperty('object', $object); + return $this->setProperty('identifier', $identifier); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/image */ - public function participant($participant) + public function image($image) { - return $this->setProperty('participant', $participant); + return $this->setProperty('image', $image); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of participant. The person that lends the object being + * borrowed. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Organization|Organization[]|Person|Person[] $lender * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/lender */ - public function startTime($startTime) + public function lender($lender) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('lender', $lender); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/BowlingAlley.php b/src/BowlingAlley.php index 4ab414858..abda4a913 100644 --- a/src/BowlingAlley.php +++ b/src/BowlingAlley.php @@ -17,126 +17,104 @@ class BowlingAlley extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Brand.php b/src/Brand.php index 48c53f150..63f786ffb 100644 --- a/src/Brand.php +++ b/src/Brand.php @@ -14,63 +14,6 @@ */ class Brand extends BaseType implements IntangibleContract, ThingContract { - /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. - * - * @param AggregateRating|AggregateRating[] $aggregateRating - * - * @return static - * - * @see http://schema.org/aggregateRating - */ - public function aggregateRating($aggregateRating) - { - return $this->setProperty('aggregateRating', $aggregateRating); - } - - /** - * An associated logo. - * - * @param ImageObject|ImageObject[]|string|string[] $logo - * - * @return static - * - * @see http://schema.org/logo - */ - public function logo($logo) - { - return $this->setProperty('logo', $logo); - } - - /** - * A review of the item. - * - * @param Review|Review[] $review - * - * @return static - * - * @see http://schema.org/review - */ - public function review($review) - { - return $this->setProperty('review', $review); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -90,6 +33,21 @@ public function additionalType($additionalType) return $this->setProperty('additionalType', $additionalType); } + /** + * The overall rating, based on a collection of reviews or ratings, of the + * item. + * + * @param AggregateRating|AggregateRating[] $aggregateRating + * + * @return static + * + * @see http://schema.org/aggregateRating + */ + public function aggregateRating($aggregateRating) + { + return $this->setProperty('aggregateRating', $aggregateRating); + } + /** * An alias for the item. * @@ -168,6 +126,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * An associated logo. + * + * @param ImageObject|ImageObject[]|string|string[] $logo + * + * @return static + * + * @see http://schema.org/logo + */ + public function logo($logo) + { + return $this->setProperty('logo', $logo); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -213,6 +185,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A review of the item. + * + * @param Review|Review[] $review + * + * @return static + * + * @see http://schema.org/review + */ + public function review($review) + { + return $this->setProperty('review', $review); + } + /** * 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 @@ -229,6 +215,20 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * A slogan or motto associated with the item. + * + * @param string|string[] $slogan + * + * @return static + * + * @see http://schema.org/slogan + */ + public function slogan($slogan) + { + return $this->setProperty('slogan', $slogan); + } + /** * A CreativeWork or Event about this Thing. * diff --git a/src/BreadcrumbList.php b/src/BreadcrumbList.php index 11d0e75c8..c09eb57ff 100644 --- a/src/BreadcrumbList.php +++ b/src/BreadcrumbList.php @@ -24,61 +24,6 @@ */ class BreadcrumbList extends BaseType implements ItemListContract, IntangibleContract, ThingContract { - /** - * For itemListElement values, you can use simple strings (e.g. "Peter", - * "Paul", "Mary"), existing entities, or use ListItem. - * - * Text values are best if the elements in the list are plain strings. - * Existing entities are best for a simple, unordered list of existing - * things in your data. ListItem is used with ordered lists when you want to - * provide additional context about the element in that list or when the - * same item might be in different places in different lists. - * - * Note: The order of elements in your mark-up is not sufficient for - * indicating the order or elements. Use ListItem with a 'position' - * property in such cases. - * - * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement - * - * @return static - * - * @see http://schema.org/itemListElement - */ - public function itemListElement($itemListElement) - { - return $this->setProperty('itemListElement', $itemListElement); - } - - /** - * Type of ordering (e.g. Ascending, Descending, Unordered). - * - * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder - * - * @return static - * - * @see http://schema.org/itemListOrder - */ - public function itemListOrder($itemListOrder) - { - return $this->setProperty('itemListOrder', $itemListOrder); - } - - /** - * The number of items in an ItemList. Note that some descriptions might not - * fully describe all items in a list (e.g., multi-page pagination); in such - * cases, the numberOfItems would be for the entire list. - * - * @param int|int[] $numberOfItems - * - * @return static - * - * @see http://schema.org/numberOfItems - */ - public function numberOfItems($numberOfItems) - { - return $this->setProperty('numberOfItems', $numberOfItems); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -176,6 +121,45 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -206,6 +190,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/Brewery.php b/src/Brewery.php index af348ff02..86d26a553 100644 --- a/src/Brewery.php +++ b/src/Brewery.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Bridge.php b/src/Bridge.php index 71dc55efc..f6c497b77 100644 --- a/src/Bridge.php +++ b/src/Bridge.php @@ -14,35 +14,6 @@ */ class Bridge extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/BroadcastChannel.php b/src/BroadcastChannel.php index f94a8b079..e76363765 100644 --- a/src/BroadcastChannel.php +++ b/src/BroadcastChannel.php @@ -13,6 +13,39 @@ */ class BroadcastChannel extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The unique address by which the BroadcastService can be identified in a * provider lineup. In US, this is typically a number. @@ -59,81 +92,6 @@ public function broadcastServiceTier($broadcastServiceTier) return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); } - /** - * Genre of the creative work, broadcast channel or group. - * - * @param string|string[] $genre - * - * @return static - * - * @see http://schema.org/genre - */ - public function genre($genre) - { - return $this->setProperty('genre', $genre); - } - - /** - * The CableOrSatelliteService offering the channel. - * - * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup - * - * @return static - * - * @see http://schema.org/inBroadcastLineup - */ - public function inBroadcastLineup($inBroadcastLineup) - { - return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); - } - - /** - * The BroadcastService offered on this channel. - * - * @param BroadcastService|BroadcastService[] $providesBroadcastService - * - * @return static - * - * @see http://schema.org/providesBroadcastService - */ - public function providesBroadcastService($providesBroadcastService) - { - return $this->setProperty('providesBroadcastService', $providesBroadcastService); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - /** * A description of the item. * @@ -165,6 +123,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -198,6 +170,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -243,6 +229,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + /** * 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 diff --git a/src/BroadcastEvent.php b/src/BroadcastEvent.php index 236cd2716..ad5a447cf 100644 --- a/src/BroadcastEvent.php +++ b/src/BroadcastEvent.php @@ -14,91 +14,6 @@ */ class BroadcastEvent extends BaseType implements PublicationEventContract, EventContract, ThingContract { - /** - * The event being broadcast such as a sporting event or awards ceremony. - * - * @param Event|Event[] $broadcastOfEvent - * - * @return static - * - * @see http://schema.org/broadcastOfEvent - */ - public function broadcastOfEvent($broadcastOfEvent) - { - return $this->setProperty('broadcastOfEvent', $broadcastOfEvent); - } - - /** - * True is the broadcast is of a live event. - * - * @param bool|bool[] $isLiveBroadcast - * - * @return static - * - * @see http://schema.org/isLiveBroadcast - */ - public function isLiveBroadcast($isLiveBroadcast) - { - return $this->setProperty('isLiveBroadcast', $isLiveBroadcast); - } - - /** - * The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, - * etc.). - * - * @param string|string[] $videoFormat - * - * @return static - * - * @see http://schema.org/videoFormat - */ - public function videoFormat($videoFormat) - { - return $this->setProperty('videoFormat', $videoFormat); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $free - * - * @return static - * - * @see http://schema.org/free - */ - public function free($free) - { - return $this->setProperty('free', $free); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * A broadcast service associated with the publication event. - * - * @param BroadcastService|BroadcastService[] $publishedOn - * - * @return static - * - * @see http://schema.org/publishedOn - */ - public function publishedOn($publishedOn) - { - return $this->setProperty('publishedOn', $publishedOn); - } - /** * The subject matter of the content. * @@ -129,6 +44,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -144,6 +78,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -186,6 +134,20 @@ public function audience($audience) return $this->setProperty('audience', $audience); } + /** + * The event being broadcast such as a sporting event or awards ceremony. + * + * @param Event|Event[] $broadcastOfEvent + * + * @return static + * + * @see http://schema.org/broadcastOfEvent + */ + public function broadcastOfEvent($broadcastOfEvent) + { + return $this->setProperty('broadcastOfEvent', $broadcastOfEvent); + } + /** * The person or organization who wrote a composition, or who is the * composer of a work performed at some event. @@ -215,6 +177,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -231,6 +207,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -290,6 +283,20 @@ public function eventStatus($eventStatus) return $this->setProperty('eventStatus', $eventStatus); } + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $free + * + * @return static + * + * @see http://schema.org/free + */ + public function free($free) + { + return $this->setProperty('free', $free); + } + /** * A person or organization that supports (sponsors) something through some * kind of financial contribution. @@ -306,494 +313,487 @@ public function funder($funder) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Language|Language[]|string|string[] $inLanguage + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/identifier */ - public function inLanguage($inLanguage) + public function identifier($identifier) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The total number of individuals that may attend an event or venue. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param int|int[] $maximumAttendeeCapacity + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/inLanguage */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function inLanguage($inLanguage) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('inLanguage', $inLanguage); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Offer|Offer[] $offers + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/isAccessibleForFree */ - public function offers($offers) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('offers', $offers); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * An organizer of an Event. + * True is the broadcast is of a live event. * - * @param Organization|Organization[]|Person|Person[] $organizer + * @param bool|bool[] $isLiveBroadcast * * @return static * - * @see http://schema.org/organizer + * @see http://schema.org/isLiveBroadcast */ - public function organizer($organizer) + public function isLiveBroadcast($isLiveBroadcast) { - return $this->setProperty('organizer', $organizer); + return $this->setProperty('isLiveBroadcast', $isLiveBroadcast); } /** - * A performer at the event—for example, a presenter, musician, - * musical group or actor. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[]|Person|Person[] $performer + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/performer + * @see http://schema.org/location */ - public function performer($performer) + public function location($location) { - return $this->setProperty('performer', $performer); + return $this->setProperty('location', $location); } /** - * The main performer or performers of the event—for example, a - * presenter, musician, or actor. - * - * @param Organization|Organization[]|Person|Person[] $performers + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/performers + * @see http://schema.org/mainEntityOfPage */ - public function performers($performers) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('performers', $performers); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/previousStartDate + * @see http://schema.org/maximumAttendeeCapacity */ - public function previousStartDate($previousStartDate) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('previousStartDate', $previousStartDate); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * The CreativeWork that captured all or part of this Event. + * The name of the item. * - * @param CreativeWork|CreativeWork[] $recordedIn + * @param string|string[] $name * * @return static * - * @see http://schema.org/recordedIn + * @see http://schema.org/name */ - public function recordedIn($recordedIn) + public function name($name) { - return $this->setProperty('recordedIn', $recordedIn); + return $this->setProperty('name', $name); } /** - * The number of attendee places for an event that remain unallocated. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param int|int[] $remainingAttendeeCapacity + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/remainingAttendeeCapacity + * @see http://schema.org/offers */ - public function remainingAttendeeCapacity($remainingAttendeeCapacity) + public function offers($offers) { - return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); + return $this->setProperty('offers', $offers); } /** - * A review of the item. + * An organizer of an Event. * - * @param Review|Review[] $review + * @param Organization|Organization[]|Person|Person[] $organizer * * @return static * - * @see http://schema.org/review + * @see http://schema.org/organizer */ - public function review($review) + public function organizer($organizer) { - return $this->setProperty('review', $review); + return $this->setProperty('organizer', $organizer); } /** - * 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. + * A performer at the event—for example, a presenter, musician, + * musical group or actor. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param Organization|Organization[]|Person|Person[] $performer * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/performer */ - public function sponsor($sponsor) + public function performer($performer) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('performer', $performer); } /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). + * The main performer or performers of the event—for example, a + * presenter, musician, or actor. * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * @param Organization|Organization[]|Person|Person[] $performers * * @return static * - * @see http://schema.org/startDate + * @see http://schema.org/performers */ - public function startDate($startDate) + public function performers($performers) { - return $this->setProperty('startDate', $startDate); + return $this->setProperty('performers', $performers); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Event|Event[] $subEvent + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/subEvent + * @see http://schema.org/potentialAction */ - public function subEvent($subEvent) + public function potentialAction($potentialAction) { - return $this->setProperty('subEvent', $subEvent); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Events that are a part of this event. For example, a conference event - * includes many presentations, each subEvents of the conference. + * 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. * - * @param Event|Event[] $subEvents + * @param \DateTimeInterface|\DateTimeInterface[] $previousStartDate * * @return static * - * @see http://schema.org/subEvents + * @see http://schema.org/previousStartDate */ - public function subEvents($subEvents) + public function previousStartDate($previousStartDate) { - return $this->setProperty('subEvents', $subEvents); + return $this->setProperty('previousStartDate', $previousStartDate); } /** - * 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. + * A broadcast service associated with the publication event. * - * @param Event|Event[] $superEvent + * @param BroadcastService|BroadcastService[] $publishedOn * * @return static * - * @see http://schema.org/superEvent + * @see http://schema.org/publishedOn */ - public function superEvent($superEvent) + public function publishedOn($publishedOn) { - return $this->setProperty('superEvent', $superEvent); + return $this->setProperty('publishedOn', $publishedOn); } /** - * 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. + * The CreativeWork that captured all or part of this Event. * - * @param Organization|Organization[]|Person|Person[] $translator + * @param CreativeWork|CreativeWork[] $recordedIn * * @return static * - * @see http://schema.org/translator + * @see http://schema.org/recordedIn */ - public function translator($translator) + public function recordedIn($recordedIn) { - return $this->setProperty('translator', $translator); + return $this->setProperty('recordedIn', $recordedIn); } /** - * The typical expected age range, e.g. '7-9', '11-'. + * The number of attendee places for an event that remain unallocated. * - * @param string|string[] $typicalAgeRange + * @param int|int[] $remainingAttendeeCapacity * * @return static * - * @see http://schema.org/typicalAgeRange + * @see http://schema.org/remainingAttendeeCapacity */ - public function typicalAgeRange($typicalAgeRange) + public function remainingAttendeeCapacity($remainingAttendeeCapacity) { - return $this->setProperty('typicalAgeRange', $typicalAgeRange); + return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); } /** - * 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). + * A review of the item. * - * @param CreativeWork|CreativeWork[] $workFeatured + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/workFeatured + * @see http://schema.org/review */ - public function workFeatured($workFeatured) + public function review($review) { - return $this->setProperty('workFeatured', $workFeatured); + return $this->setProperty('review', $review); } /** - * A work performed in some event, for example a play performed in a - * TheaterEvent. + * 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. * - * @param CreativeWork|CreativeWork[] $workPerformed + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/workPerformed + * @see http://schema.org/sameAs */ - public function workPerformed($workPerformed) + public function sameAs($sameAs) { - return $this->setProperty('workPerformed', $workPerformed); + return $this->setProperty('sameAs', $sameAs); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * 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. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/sponsor */ - public function additionalType($additionalType) + public function sponsor($sponsor) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('sponsor', $sponsor); } /** - * An alias for the item. + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). * - * @param string|string[] $alternateName + * @param \DateTimeInterface|\DateTimeInterface[] $startDate * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/startDate */ - public function alternateName($alternateName) + public function startDate($startDate) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('startDate', $startDate); } /** - * A description of the item. + * 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. * - * @param string|string[] $description + * @param Event|Event[] $subEvent * * @return static * - * @see http://schema.org/description + * @see http://schema.org/subEvent */ - public function description($description) + public function subEvent($subEvent) { - return $this->setProperty('description', $description); + return $this->setProperty('subEvent', $subEvent); } /** - * 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. + * Events that are a part of this event. For example, a conference event + * includes many presentations, each subEvents of the conference. * - * @param string|string[] $disambiguatingDescription + * @param Event|Event[] $subEvents * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/subEvents */ - public function disambiguatingDescription($disambiguatingDescription) + public function subEvents($subEvents) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('subEvents', $subEvents); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A CreativeWork or Event about this Thing. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/subjectOf */ - public function identifier($identifier) + public function subjectOf($subjectOf) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('subjectOf', $subjectOf); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Event|Event[] $superEvent * * @return static * - * @see http://schema.org/image + * @see http://schema.org/superEvent */ - public function image($image) + public function superEvent($superEvent) { - return $this->setProperty('image', $image); + return $this->setProperty('superEvent', $superEvent); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[]|Person|Person[] $translator * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/translator */ - public function mainEntityOfPage($mainEntityOfPage) + public function translator($translator) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('translator', $translator); } /** - * The name of the item. + * The typical expected age range, e.g. '7-9', '11-'. * - * @param string|string[] $name + * @param string|string[] $typicalAgeRange * * @return static * - * @see http://schema.org/name + * @see http://schema.org/typicalAgeRange */ - public function name($name) + public function typicalAgeRange($typicalAgeRange) { - return $this->setProperty('name', $name); + return $this->setProperty('typicalAgeRange', $typicalAgeRange); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, + * etc.). * - * @param string|string[] $sameAs + * @param string|string[] $videoFormat * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/videoFormat */ - public function sameAs($sameAs) + public function videoFormat($videoFormat) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('videoFormat', $videoFormat); } /** - * A CreativeWork or Event about this Thing. + * 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). * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param CreativeWork|CreativeWork[] $workFeatured * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/workFeatured */ - public function subjectOf($subjectOf) + public function workFeatured($workFeatured) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('workFeatured', $workFeatured); } /** - * URL of the item. + * A work performed in some event, for example a play performed in a + * TheaterEvent. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workPerformed * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workPerformed */ - public function url($url) + public function workPerformed($workPerformed) { - return $this->setProperty('url', $url); + return $this->setProperty('workPerformed', $workPerformed); } } diff --git a/src/BroadcastFrequencySpecification.php b/src/BroadcastFrequencySpecification.php index 8e0a3fe44..8f93e832b 100644 --- a/src/BroadcastFrequencySpecification.php +++ b/src/BroadcastFrequencySpecification.php @@ -14,20 +14,6 @@ */ class BroadcastFrequencySpecification extends BaseType implements IntangibleContract, ThingContract { - /** - * The frequency in MHz for a particular broadcast. - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $broadcastFrequencyValue - * - * @return static - * - * @see http://schema.org/broadcastFrequencyValue - */ - public function broadcastFrequencyValue($broadcastFrequencyValue) - { - return $this->setProperty('broadcastFrequencyValue', $broadcastFrequencyValue); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -61,6 +47,20 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The frequency in MHz for a particular broadcast. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $broadcastFrequencyValue + * + * @return static + * + * @see http://schema.org/broadcastFrequencyValue + */ + public function broadcastFrequencyValue($broadcastFrequencyValue) + { + return $this->setProperty('broadcastFrequencyValue', $broadcastFrequencyValue); + } + /** * A description of the item. * diff --git a/src/BroadcastService.php b/src/BroadcastService.php index 4af34e2bb..7102b533c 100644 --- a/src/BroadcastService.php +++ b/src/BroadcastService.php @@ -16,222 +16,211 @@ class BroadcastService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { /** - * The area within which users can expect to reach the broadcast service. - * - * @param Place|Place[] $area - * - * @return static - * - * @see http://schema.org/area - */ - public function area($area) - { - return $this->setProperty('area', $area); - } - - /** - * The media network(s) whose content is broadcast on this station. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $broadcastAffiliateOf + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/broadcastAffiliateOf + * @see http://schema.org/additionalType */ - public function broadcastAffiliateOf($broadcastAffiliateOf) + public function additionalType($additionalType) { - return $this->setProperty('broadcastAffiliateOf', $broadcastAffiliateOf); + return $this->setProperty('additionalType', $additionalType); } /** - * The name displayed in the channel guide. For many US affiliates, it is - * the network name. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $broadcastDisplayName + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/broadcastDisplayName + * @see http://schema.org/aggregateRating */ - public function broadcastDisplayName($broadcastDisplayName) + public function aggregateRating($aggregateRating) { - return $this->setProperty('broadcastDisplayName', $broadcastDisplayName); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The frequency used for over-the-air broadcasts. Numeric values or simple - * ranges e.g. 87-99. In addition a shortcut idiom is supported for - * frequences of AM and FM radio channels, e.g. "87 FM". + * An alias for the item. * - * @param BroadcastFrequencySpecification|BroadcastFrequencySpecification[]|string|string[] $broadcastFrequency + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/broadcastFrequency + * @see http://schema.org/alternateName */ - public function broadcastFrequency($broadcastFrequency) + public function alternateName($alternateName) { - return $this->setProperty('broadcastFrequency', $broadcastFrequency); + return $this->setProperty('alternateName', $alternateName); } /** - * The timezone in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) - * for which the service bases its broadcasts + * The area within which users can expect to reach the broadcast service. * - * @param string|string[] $broadcastTimezone + * @param Place|Place[] $area * * @return static * - * @see http://schema.org/broadcastTimezone + * @see http://schema.org/area */ - public function broadcastTimezone($broadcastTimezone) + public function area($area) { - return $this->setProperty('broadcastTimezone', $broadcastTimezone); + return $this->setProperty('area', $area); } /** - * The organization owning or operating the broadcast service. + * The geographic area where a service or offered item is provided. * - * @param Organization|Organization[] $broadcaster + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/broadcaster + * @see http://schema.org/areaServed */ - public function broadcaster($broadcaster) + public function areaServed($areaServed) { - return $this->setProperty('broadcaster', $broadcaster); + return $this->setProperty('areaServed', $areaServed); } /** - * A broadcast channel of a broadcast service. + * An intended audience, i.e. a group for whom something was created. * - * @param BroadcastChannel|BroadcastChannel[] $hasBroadcastChannel + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/hasBroadcastChannel + * @see http://schema.org/audience */ - public function hasBroadcastChannel($hasBroadcastChannel) + public function audience($audience) { - return $this->setProperty('hasBroadcastChannel', $hasBroadcastChannel); + return $this->setProperty('audience', $audience); } /** - * A broadcast service to which the broadcast service may belong to such as - * regional variations of a national channel. + * A means of accessing the service (e.g. a phone bank, a web site, a + * location, etc.). * - * @param BroadcastService|BroadcastService[] $parentService + * @param ServiceChannel|ServiceChannel[] $availableChannel * * @return static * - * @see http://schema.org/parentService + * @see http://schema.org/availableChannel */ - public function parentService($parentService) + public function availableChannel($availableChannel) { - return $this->setProperty('parentService', $parentService); + return $this->setProperty('availableChannel', $availableChannel); } /** - * The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, - * etc.). + * An award won by or for this item. * - * @param string|string[] $videoFormat + * @param string|string[] $award * * @return static * - * @see http://schema.org/videoFormat + * @see http://schema.org/award */ - public function videoFormat($videoFormat) + public function award($award) { - return $this->setProperty('videoFormat', $videoFormat); + return $this->setProperty('award', $award); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/brand */ - public function aggregateRating($aggregateRating) + public function brand($brand) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('brand', $brand); } /** - * The geographic area where a service or offered item is provided. + * The media network(s) whose content is broadcast on this station. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Organization|Organization[] $broadcastAffiliateOf * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/broadcastAffiliateOf */ - public function areaServed($areaServed) + public function broadcastAffiliateOf($broadcastAffiliateOf) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('broadcastAffiliateOf', $broadcastAffiliateOf); } /** - * An intended audience, i.e. a group for whom something was created. + * The name displayed in the channel guide. For many US affiliates, it is + * the network name. * - * @param Audience|Audience[] $audience + * @param string|string[] $broadcastDisplayName * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/broadcastDisplayName */ - public function audience($audience) + public function broadcastDisplayName($broadcastDisplayName) { - return $this->setProperty('audience', $audience); + return $this->setProperty('broadcastDisplayName', $broadcastDisplayName); } /** - * A means of accessing the service (e.g. a phone bank, a web site, a - * location, etc.). + * The frequency used for over-the-air broadcasts. Numeric values or simple + * ranges e.g. 87-99. In addition a shortcut idiom is supported for + * frequences of AM and FM radio channels, e.g. "87 FM". * - * @param ServiceChannel|ServiceChannel[] $availableChannel + * @param BroadcastFrequencySpecification|BroadcastFrequencySpecification[]|string|string[] $broadcastFrequency * * @return static * - * @see http://schema.org/availableChannel + * @see http://schema.org/broadcastFrequency */ - public function availableChannel($availableChannel) + public function broadcastFrequency($broadcastFrequency) { - return $this->setProperty('availableChannel', $availableChannel); + return $this->setProperty('broadcastFrequency', $broadcastFrequency); } /** - * An award won by or for this item. + * The timezone in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) + * for which the service bases its broadcasts * - * @param string|string[] $award + * @param string|string[] $broadcastTimezone * * @return static * - * @see http://schema.org/award + * @see http://schema.org/broadcastTimezone */ - public function award($award) + public function broadcastTimezone($broadcastTimezone) { - return $this->setProperty('award', $award); + return $this->setProperty('broadcastTimezone', $broadcastTimezone); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The organization owning or operating the broadcast service. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Organization|Organization[] $broadcaster * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/broadcaster */ - public function brand($brand) + public function broadcaster($broadcaster) { - return $this->setProperty('brand', $brand); + return $this->setProperty('broadcaster', $broadcaster); } /** @@ -267,380 +256,376 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * A description of the item. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/description */ - public function hasOfferCatalog($hasOfferCatalog) + public function description($description) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('description', $description); } /** - * The hours during which this service or contact is available. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/disambiguatingDescription */ - public function hoursAvailable($hoursAvailable) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, somehow related product (or multiple products). + * A broadcast channel of a broadcast service. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param BroadcastChannel|BroadcastChannel[] $hasBroadcastChannel * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/hasBroadcastChannel */ - public function isRelatedTo($isRelatedTo) + public function hasBroadcastChannel($hasBroadcastChannel) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('hasBroadcastChannel', $hasBroadcastChannel); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/hasOfferCatalog */ - public function isSimilarTo($isSimilarTo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An associated logo. + * The hours during which this service or contact is available. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hoursAvailable */ - public function logo($logo) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $offers + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/identifier */ - public function offers($offers) + public function identifier($identifier) { - return $this->setProperty('offers', $offers); + return $this->setProperty('identifier', $identifier); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $produces + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/image */ - public function produces($produces) + public function image($image) { - return $this->setProperty('produces', $produces); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * A pointer to another, somehow related product (or multiple products). * - * @param Organization|Organization[]|Person|Person[] $provider + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/isRelatedTo */ - public function provider($provider) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('provider', $provider); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * A pointer to another, functionally similar product (or multiple + * products). * - * @param string|string[] $providerMobility + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/isSimilarTo */ - public function providerMobility($providerMobility) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * A review of the item. + * An associated logo. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/logo */ - public function review($review) + public function logo($logo) { - return $this->setProperty('review', $review); + return $this->setProperty('logo', $logo); } /** - * The geographic area where the service is provided. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/mainEntityOfPage */ - public function serviceArea($serviceArea) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The audience eligible for this service. + * The name of the item. * - * @param Audience|Audience[] $serviceAudience + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/name */ - public function serviceAudience($serviceAudience) + public function name($name) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('name', $name); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param Thing|Thing[] $serviceOutput + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/offers */ - public function serviceOutput($serviceOutput) + public function offers($offers) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('offers', $offers); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * A broadcast service to which the broadcast service may belong to such as + * regional variations of a national channel. * - * @param string|string[] $serviceType + * @param BroadcastService|BroadcastService[] $parentService * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/parentService */ - public function serviceType($serviceType) + public function parentService($parentService) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('parentService', $parentService); } /** - * A slogan or motto associated with the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $slogan + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/potentialAction */ - public function slogan($slogan) + public function potentialAction($potentialAction) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/produces */ - public function additionalType($additionalType) + public function produces($produces) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('produces', $produces); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $description + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/description + * @see http://schema.org/providerMobility */ - public function description($description) + public function providerMobility($providerMobility) { - return $this->setProperty('description', $description); + return $this->setProperty('providerMobility', $providerMobility); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** @@ -671,4 +656,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, + * etc.). + * + * @param string|string[] $videoFormat + * + * @return static + * + * @see http://schema.org/videoFormat + */ + public function videoFormat($videoFormat) + { + return $this->setProperty('videoFormat', $videoFormat); + } + } diff --git a/src/BuddhistTemple.php b/src/BuddhistTemple.php index bcd308fca..cc877105a 100644 --- a/src/BuddhistTemple.php +++ b/src/BuddhistTemple.php @@ -15,35 +15,6 @@ */ class BuddhistTemple extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/BusReservation.php b/src/BusReservation.php index c4f752c3f..68c9e467d 100644 --- a/src/BusReservation.php +++ b/src/BusReservation.php @@ -18,6 +18,39 @@ */ class BusReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as * a booking agent. @@ -65,335 +98,302 @@ public function broker($broker) } /** - * The date and time the reservation was modified. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/description */ - public function modifiedTime($modifiedTime) + public function description($description) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('description', $description); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. * - * @param string|string[] $priceCurrency + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/disambiguatingDescription */ - public function priceCurrency($priceCurrency) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/identifier */ - public function programMembershipUsed($programMembershipUsed) + public function identifier($identifier) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('identifier', $identifier); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/image */ - public function provider($provider) + public function image($image) { - return $this->setProperty('provider', $provider); + return $this->setProperty('image', $image); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $reservationFor + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/mainEntityOfPage */ - public function reservationFor($reservationFor) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A unique identifier for the reservation. + * The date and time the reservation was modified. * - * @param string|string[] $reservationId + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/modifiedTime */ - public function reservationId($reservationId) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The current status of the reservation. + * The name of the item. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/name */ - public function reservationStatus($reservationStatus) + public function name($name) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('name', $name); } /** - * A ticket associated with the reservation. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Ticket|Ticket[] $reservedTicket + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/potentialAction */ - public function reservedTicket($reservedTicket) + public function potentialAction($potentialAction) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice - * - * @return static - * - * @see http://schema.org/totalPrice - */ - public function totalPrice($totalPrice) - { - return $this->setProperty('totalPrice', $totalPrice); - } - - /** - * The person or organization the reservation or ticket is for. - * - * @param Organization|Organization[]|Person|Person[] $underName - * - * @return static - * - * @see http://schema.org/underName - */ - public function underName($underName) - { - return $this->setProperty('underName', $underName); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $additionalType + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/priceCurrency */ - public function additionalType($additionalType) + public function priceCurrency($priceCurrency) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An alias for the item. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $alternateName + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/programMembershipUsed */ - public function alternateName($alternateName) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * A description of the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/description + * @see http://schema.org/provider */ - public function description($description) + public function provider($provider) { - return $this->setProperty('description', $description); + return $this->setProperty('provider', $provider); } /** - * 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. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/reservationFor */ - public function disambiguatingDescription($disambiguatingDescription) + public function reservationFor($reservationFor) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('reservationFor', $reservationFor); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A unique identifier for the reservation. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reservationId */ - public function identifier($identifier) + public function reservationId($reservationId) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reservationId', $reservationId); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The current status of the reservation. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservationStatus */ - public function image($image) + public function reservationStatus($reservationStatus) { - return $this->setProperty('image', $image); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A ticket associated with the reservation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/reservedTicket */ - public function mainEntityOfPage($mainEntityOfPage) + public function reservedTicket($reservedTicket) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('reservedTicket', $reservedTicket); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param string|string[] $sameAs + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/totalPrice */ - public function sameAs($sameAs) + public function totalPrice($totalPrice) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('totalPrice', $totalPrice); } /** - * A CreativeWork or Event about this Thing. + * The person or organization the reservation or ticket is for. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Organization|Organization[]|Person|Person[] $underName * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/underName */ - public function subjectOf($subjectOf) + public function underName($underName) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('underName', $underName); } /** diff --git a/src/BusStation.php b/src/BusStation.php index 6e08f403a..469ca28e3 100644 --- a/src/BusStation.php +++ b/src/BusStation.php @@ -14,35 +14,6 @@ */ class BusStation extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/BusStop.php b/src/BusStop.php index 839a78fbe..117f90f5d 100644 --- a/src/BusStop.php +++ b/src/BusStop.php @@ -14,35 +14,6 @@ */ class BusStop extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/BusTrip.php b/src/BusTrip.php index 7b7d61a07..fab35ef70 100644 --- a/src/BusTrip.php +++ b/src/BusTrip.php @@ -15,59 +15,50 @@ class BusTrip extends BaseType implements TripContract, IntangibleContract, ThingContract { /** - * The stop or station from which the bus arrives. - * - * @param BusStation|BusStation[]|BusStop|BusStop[] $arrivalBusStop - * - * @return static - * - * @see http://schema.org/arrivalBusStop - */ - public function arrivalBusStop($arrivalBusStop) - { - return $this->setProperty('arrivalBusStop', $arrivalBusStop); - } - - /** - * The name of the bus (e.g. Bolt Express). + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $busName + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/busName + * @see http://schema.org/additionalType */ - public function busName($busName) + public function additionalType($additionalType) { - return $this->setProperty('busName', $busName); + return $this->setProperty('additionalType', $additionalType); } /** - * The unique identifier for the bus. + * An alias for the item. * - * @param string|string[] $busNumber + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/busNumber + * @see http://schema.org/alternateName */ - public function busNumber($busNumber) + public function alternateName($alternateName) { - return $this->setProperty('busNumber', $busNumber); + return $this->setProperty('alternateName', $alternateName); } /** - * The stop or station from which the bus departs. + * The stop or station from which the bus arrives. * - * @param BusStation|BusStation[]|BusStop|BusStop[] $departureBusStop + * @param BusStation|BusStation[]|BusStop|BusStop[] $arrivalBusStop * * @return static * - * @see http://schema.org/departureBusStop + * @see http://schema.org/arrivalBusStop */ - public function departureBusStop($departureBusStop) + public function arrivalBusStop($arrivalBusStop) { - return $this->setProperty('departureBusStop', $departureBusStop); + return $this->setProperty('arrivalBusStop', $arrivalBusStop); } /** @@ -85,82 +76,59 @@ public function arrivalTime($arrivalTime) } /** - * The expected departure time. - * - * @param \DateTimeInterface|\DateTimeInterface[] $departureTime - * - * @return static - * - * @see http://schema.org/departureTime - */ - public function departureTime($departureTime) - { - return $this->setProperty('departureTime', $departureTime); - } - - /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * The name of the bus (e.g. Bolt Express). * - * @param Offer|Offer[] $offers + * @param string|string[] $busName * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/busName */ - public function offers($offers) + public function busName($busName) { - return $this->setProperty('offers', $offers); + return $this->setProperty('busName', $busName); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The unique identifier for the bus. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param string|string[] $busNumber * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/busNumber */ - public function provider($provider) + public function busNumber($busNumber) { - return $this->setProperty('provider', $provider); + return $this->setProperty('busNumber', $busNumber); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The stop or station from which the bus departs. * - * @param string|string[] $additionalType + * @param BusStation|BusStation[]|BusStop|BusStop[] $departureBusStop * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/departureBusStop */ - public function additionalType($additionalType) + public function departureBusStop($departureBusStop) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('departureBusStop', $departureBusStop); } /** - * An alias for the item. + * The expected departure time. * - * @param string|string[] $alternateName + * @param \DateTimeInterface|\DateTimeInterface[] $departureTime * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/departureTime */ - public function alternateName($alternateName) + public function departureTime($departureTime) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('departureTime', $departureTime); } /** @@ -257,6 +225,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -272,6 +256,22 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + /** * 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 diff --git a/src/BusinessAudience.php b/src/BusinessAudience.php index 5970a6b7b..98d059664 100644 --- a/src/BusinessAudience.php +++ b/src/BusinessAudience.php @@ -15,77 +15,6 @@ */ class BusinessAudience extends BaseType implements AudienceContract, IntangibleContract, ThingContract { - /** - * The number of employees in an organization e.g. business. - * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees - * - * @return static - * - * @see http://schema.org/numberOfEmployees - */ - public function numberOfEmployees($numberOfEmployees) - { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); - } - - /** - * The size of the business in annual revenue. - * - * @param QuantitativeValue|QuantitativeValue[] $yearlyRevenue - * - * @return static - * - * @see http://schema.org/yearlyRevenue - */ - public function yearlyRevenue($yearlyRevenue) - { - return $this->setProperty('yearlyRevenue', $yearlyRevenue); - } - - /** - * The age of the business. - * - * @param QuantitativeValue|QuantitativeValue[] $yearsInOperation - * - * @return static - * - * @see http://schema.org/yearsInOperation - */ - public function yearsInOperation($yearsInOperation) - { - return $this->setProperty('yearsInOperation', $yearsInOperation); - } - - /** - * The target group associated with a given audience (e.g. veterans, car - * owners, musicians, etc.). - * - * @param string|string[] $audienceType - * - * @return static - * - * @see http://schema.org/audienceType - */ - public function audienceType($audienceType) - { - return $this->setProperty('audienceType', $audienceType); - } - - /** - * The geographic area associated with the audience. - * - * @param AdministrativeArea|AdministrativeArea[] $geographicArea - * - * @return static - * - * @see http://schema.org/geographicArea - */ - public function geographicArea($geographicArea) - { - return $this->setProperty('geographicArea', $geographicArea); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -119,6 +48,21 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The target group associated with a given audience (e.g. veterans, car + * owners, musicians, etc.). + * + * @param string|string[] $audienceType + * + * @return static + * + * @see http://schema.org/audienceType + */ + public function audienceType($audienceType) + { + return $this->setProperty('audienceType', $audienceType); + } + /** * A description of the item. * @@ -150,6 +94,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -213,6 +171,20 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The number of employees in an organization e.g. business. + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * + * @return static + * + * @see http://schema.org/numberOfEmployees + */ + public function numberOfEmployees($numberOfEmployees) + { + return $this->setProperty('numberOfEmployees', $numberOfEmployees); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -272,4 +244,32 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The size of the business in annual revenue. + * + * @param QuantitativeValue|QuantitativeValue[] $yearlyRevenue + * + * @return static + * + * @see http://schema.org/yearlyRevenue + */ + public function yearlyRevenue($yearlyRevenue) + { + return $this->setProperty('yearlyRevenue', $yearlyRevenue); + } + + /** + * The age of the business. + * + * @param QuantitativeValue|QuantitativeValue[] $yearsInOperation + * + * @return static + * + * @see http://schema.org/yearsInOperation + */ + public function yearsInOperation($yearsInOperation) + { + return $this->setProperty('yearsInOperation', $yearsInOperation); + } + } diff --git a/src/BusinessEvent.php b/src/BusinessEvent.php index b19ddd194..1c5e3ccb6 100644 --- a/src/BusinessEvent.php +++ b/src/BusinessEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/BuyAction.php b/src/BuyAction.php index e3944a511..7a4b57b2c 100644 --- a/src/BuyAction.php +++ b/src/BuyAction.php @@ -17,150 +17,96 @@ class BuyAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * An entity which offers (sells / leases / lends / loans) the services / - * goods. A seller may also be a provider. - * - * @param Organization|Organization[]|Person|Person[] $seller - * - * @return static - * - * @see http://schema.org/seller - */ - public function seller($seller) - { - return $this->setProperty('seller', $seller); - } - - /** - * 'vendor' is an earlier term for 'seller'. - * - * @param Organization|Organization[]|Person|Person[] $vendor - * - * @return static - * - * @see http://schema.org/vendor - */ - public function vendor($vendor) - { - return $this->setProperty('vendor', $vendor); - } - - /** - * The warranty promise(s) included in the offer. + * Indicates the current disposition of the Action. * - * @param WarrantyPromise|WarrantyPromise[] $warrantyPromise + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/warrantyPromise + * @see http://schema.org/actionStatus */ - public function warrantyPromise($warrantyPromise) + public function actionStatus($actionStatus) { - return $this->setProperty('warrantyPromise', $warrantyPromise); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param float|float[]|int|int[]|string|string[] $price + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/price + * @see http://schema.org/additionalType */ - public function price($price) + public function additionalType($additionalType) { - return $this->setProperty('price', $price); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param string|string[] $priceCurrency + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/agent */ - public function priceCurrency($priceCurrency) + public function agent($agent) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('agent', $agent); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * An alias for the item. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/alternateName */ - public function priceSpecification($priceSpecification) + public function alternateName($alternateName) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -200,6 +146,39 @@ public function error($error) return $this->setProperty('error', $error); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The object that helped the agent perform the action. e.g. John wrote a * book with *a pen*. @@ -231,272 +210,293 @@ public function location($location) } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $object + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/object + * @see http://schema.org/mainEntityOfPage */ - public function object($object) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('object', $object); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The name of the item. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param string|string[] $name * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/name */ - public function participant($participant) + public function name($name) { - return $this->setProperty('participant', $participant); + return $this->setProperty('name', $name); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/result + * @see http://schema.org/object */ - public function result($result) + public function object($object) { - return $this->setProperty('result', $result); + return $this->setProperty('object', $object); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/participant */ - public function startTime($startTime) + public function participant($participant) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('participant', $participant); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param EntryPoint|EntryPoint[] $target + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/target + * @see http://schema.org/potentialAction */ - public function target($target) + public function potentialAction($potentialAction) { - return $this->setProperty('target', $target); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $additionalType + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/price */ - public function additionalType($additionalType) + public function price($price) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('price', $price); } /** - * An alias for the item. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $alternateName + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/priceCurrency */ - public function alternateName($alternateName) + public function priceCurrency($priceCurrency) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * A description of the item. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param string|string[] $description + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/description + * @see http://schema.org/priceSpecification */ - public function description($description) + public function priceSpecification($priceSpecification) { - return $this->setProperty('description', $description); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * 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. + * The result produced in the action. e.g. John wrote *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/result */ - public function disambiguatingDescription($disambiguatingDescription) + public function result($result) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('result', $result); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * An entity which offers (sells / leases / lends / loans) the services / + * goods. A seller may also be a provider. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[]|Person|Person[] $seller * * @return static * - * @see http://schema.org/image + * @see http://schema.org/seller */ - public function image($image) + public function seller($seller) { - return $this->setProperty('image', $image); + return $this->setProperty('seller', $seller); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/startTime */ - public function mainEntityOfPage($mainEntityOfPage) + public function startTime($startTime) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('startTime', $startTime); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates a target EntryPoint for an Action. * - * @param Action|Action[] $potentialAction + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/target */ - public function potentialAction($potentialAction) + public function target($target) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('target', $target); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * 'vendor' is an earlier term for 'seller'. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Organization|Organization[]|Person|Person[] $vendor * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/vendor */ - public function subjectOf($subjectOf) + public function vendor($vendor) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('vendor', $vendor); } /** - * URL of the item. + * The warranty promise(s) included in the offer. * - * @param string|string[] $url + * @param WarrantyPromise|WarrantyPromise[] $warrantyPromise * * @return static * - * @see http://schema.org/url + * @see http://schema.org/warrantyPromise */ - public function url($url) + public function warrantyPromise($warrantyPromise) { - return $this->setProperty('url', $url); + return $this->setProperty('warrantyPromise', $warrantyPromise); } } diff --git a/src/CableOrSatelliteService.php b/src/CableOrSatelliteService.php index d4cb1bb17..49e760b4e 100644 --- a/src/CableOrSatelliteService.php +++ b/src/CableOrSatelliteService.php @@ -15,6 +15,25 @@ */ class CableOrSatelliteService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -30,6 +49,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -134,6 +167,37 @@ public function category($category) return $this->setProperty('category', $category); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -163,6 +227,39 @@ public function hoursAvailable($hoursAvailable) return $this->setProperty('hoursAvailable', $hoursAvailable); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another, somehow related product (or multiple products). * @@ -206,6 +303,36 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -222,6 +349,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The tangible thing generated by the service, e.g. a passport, permit, * etc. @@ -281,6 +423,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The geographic area where the service is provided. * @@ -353,164 +511,6 @@ public function slogan($slogan) return $this->setProperty('slogan', $slogan); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - /** * A CreativeWork or Event about this Thing. * diff --git a/src/CafeOrCoffeeShop.php b/src/CafeOrCoffeeShop.php index c848ca651..908ff1f55 100644 --- a/src/CafeOrCoffeeShop.php +++ b/src/CafeOrCoffeeShop.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Campground.php b/src/Campground.php index 359709570..9cbc132e1 100644 --- a/src/Campground.php +++ b/src/Campground.php @@ -34,35 +34,6 @@ */ class Campground extends BaseType implements CivicStructureContract, LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -85,6 +56,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -114,6 +104,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -132,1320 +136,1316 @@ public function amenityFeature($amenityFeature) } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The geographic area where a service or offered item is provided. * - * @param string|string[] $branchCode + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/areaServed */ - public function branchCode($branchCode) + public function areaServed($areaServed) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('areaServed', $areaServed); } /** - * The basic containment relation between a place and one that contains it. + * An intended audience, i.e. a group for whom something was created. * - * @param Place|Place[] $containedIn + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/audience */ - public function containedIn($containedIn) + public function audience($audience) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('audience', $audience); } /** - * The basic containment relation between a place and one that contains it. + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] * - * @param Place|Place[] $containedInPlace + * @param Language|Language[]|string|string[] $availableLanguage * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/availableLanguage */ - public function containedInPlace($containedInPlace) + public function availableLanguage($availableLanguage) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('availableLanguage', $availableLanguage); } /** - * The basic containment relation between a place and another that it - * contains. + * An award won by or for this item. * - * @param Place|Place[] $containsPlace + * @param string|string[] $award * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/award */ - public function containsPlace($containsPlace) + public function award($award) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('award', $award); } /** - * Upcoming or past event associated with this place, organization, or - * action. + * Awards won by or for this item. * - * @param Event|Event[] $event + * @param string|string[] $awards * * @return static * - * @see http://schema.org/event + * @see http://schema.org/awards */ - public function event($event) + public function awards($awards) { - return $this->setProperty('event', $event); + return $this->setProperty('awards', $awards); } /** - * Upcoming or past events associated with this place or organization. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param Event|Event[] $events + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/events + * @see http://schema.org/branchCode */ - public function events($events) + public function branchCode($branchCode) { - return $this->setProperty('events', $events); + return $this->setProperty('branchCode', $branchCode); } /** - * The fax number. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $faxNumber + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/faxNumber + * @see http://schema.org/branchOf */ - public function faxNumber($faxNumber) + public function branchOf($branchOf) { - return $this->setProperty('faxNumber', $faxNumber); + return $this->setProperty('branchOf', $branchOf); } /** - * The geo coordinates of the place. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/brand */ - public function geo($geo) + public function brand($brand) { - return $this->setProperty('geo', $geo); + return $this->setProperty('brand', $brand); } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The earliest someone may check into a lodging establishment. * - * @param string|string[] $globalLocationNumber + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/checkinTime */ - public function globalLocationNumber($globalLocationNumber) + public function checkinTime($checkinTime) { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); + return $this->setProperty('checkinTime', $checkinTime); } /** - * A URL to a map of the place. + * The latest someone may check out of a lodging establishment. * - * @param Map|Map[]|string|string[] $hasMap + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/checkoutTime */ - public function hasMap($hasMap) + public function checkoutTime($checkoutTime) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('checkoutTime', $checkoutTime); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A contact point for a person or organization. * - * @param bool|bool[] $isAccessibleForFree + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/contactPoint */ - public function isAccessibleForFree($isAccessibleForFree) + public function contactPoint($contactPoint) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * A contact point for a person or organization. * - * @param string|string[] $isicV4 + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/contactPoints */ - public function isicV4($isicV4) + public function contactPoints($contactPoints) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The basic containment relation between a place and one that contains it. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/containedIn */ - public function latitude($latitude) + public function containedIn($containedIn) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('containedIn', $containedIn); } /** - * An associated logo. + * The basic containment relation between a place and one that contains it. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/containedInPlace */ - public function logo($logo) + public function containedInPlace($containedInPlace) { - return $this->setProperty('logo', $logo); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The basic containment relation between a place and another that it + * contains. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/containsPlace */ - public function longitude($longitude) + public function containsPlace($containsPlace) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('containsPlace', $containsPlace); } /** - * A URL to a map of the place. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $map + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/map + * @see http://schema.org/currenciesAccepted */ - public function map($map) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('map', $map); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A URL to a map of the place. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param string|string[] $maps + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/department */ - public function maps($maps) + public function department($department) { - return $this->setProperty('maps', $maps); + return $this->setProperty('department', $department); } /** - * The total number of individuals that may attend an event or venue. + * A description of the item. * - * @param int|int[] $maximumAttendeeCapacity + * @param string|string[] $description * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/description */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function description($description) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('description', $description); } /** - * The opening hours of a certain place. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/disambiguatingDescription */ - public function openingHoursSpecification($openingHoursSpecification) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A photograph of this place. + * The date that this organization was dissolved. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/dissolutionDate */ - public function photo($photo) + public function dissolutionDate($dissolutionDate) { - return $this->setProperty('photo', $photo); + return $this->setProperty('dissolutionDate', $dissolutionDate); } /** - * Photographs of this place. + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $duns * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/duns */ - public function photos($photos) + public function duns($duns) { - return $this->setProperty('photos', $photos); + return $this->setProperty('duns', $duns); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * Email address. * - * @param bool|bool[] $publicAccess + * @param string|string[] $email * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/email */ - public function publicAccess($publicAccess) + public function email($email) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('email', $email); } /** - * A review of the item. + * Someone working for this organization. * - * @param Review|Review[] $review + * @param Person|Person[] $employee * * @return static * - * @see http://schema.org/review + * @see http://schema.org/employee */ - public function review($review) + public function employee($employee) { - return $this->setProperty('review', $review); + return $this->setProperty('employee', $employee); } /** - * Review of the item. + * People working for this organization. * - * @param Review|Review[] $reviews + * @param Person|Person[] $employees * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/employees */ - public function reviews($reviews) + public function employees($employees) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('employees', $employees); } /** - * A slogan or motto associated with the item. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param string|string[] $slogan + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/event */ - public function slogan($slogan) + public function event($event) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('event', $event); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Upcoming or past events associated with this place or organization. * - * @param bool|bool[] $smokingAllowed + * @param Event|Event[] $events * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/events */ - public function smokingAllowed($smokingAllowed) + public function events($events) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('events', $events); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The fax number. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $faxNumber * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/faxNumber */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function faxNumber($faxNumber) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('faxNumber', $faxNumber); } /** - * The telephone number. + * A person who founded this organization. * - * @param string|string[] $telephone + * @param Person|Person[] $founder * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/founder */ - public function telephone($telephone) + public function founder($founder) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('founder', $founder); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * A person who founded this organization. * - * @param string|string[] $additionalType + * @param Person|Person[] $founders * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/founders */ - public function additionalType($additionalType) + public function founders($founders) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('founders', $founders); } /** - * An alias for the item. + * The date that this organization was founded. * - * @param string|string[] $alternateName + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/foundingDate */ - public function alternateName($alternateName) + public function foundingDate($foundingDate) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('foundingDate', $foundingDate); } /** - * A description of the item. + * The place where the Organization was founded. * - * @param string|string[] $description + * @param Place|Place[] $foundingLocation * * @return static * - * @see http://schema.org/description + * @see http://schema.org/foundingLocation */ - public function description($description) + public function foundingLocation($foundingLocation) { - return $this->setProperty('description', $description); + return $this->setProperty('foundingLocation', $foundingLocation); } /** - * 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. + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $funder * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/funder */ - public function disambiguatingDescription($disambiguatingDescription) + public function funder($funder) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('funder', $funder); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The geo coordinates of the place. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/geo */ - public function identifier($identifier) + public function geo($geo) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('geo', $geo); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/image + * @see http://schema.org/globalLocationNumber */ - public function image($image) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('image', $image); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A URL to a map of the place. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/hasMap */ - public function mainEntityOfPage($mainEntityOfPage) + public function hasMap($hasMap) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('hasMap', $hasMap); } /** - * The name of the item. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param string|string[] $name + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/name + * @see http://schema.org/hasOfferCatalog */ - public function name($name) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('name', $name); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Points-of-Sales operated by the organization or person. * - * @param Action|Action[] $potentialAction + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/hasPOS */ - public function potentialAction($potentialAction) + public function hasPOS($hasPOS) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('hasPOS', $hasPOS); } /** - * 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. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $sameAs + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/identifier */ - public function sameAs($sameAs) + public function identifier($identifier) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('identifier', $identifier); } /** - * A CreativeWork or Event about this Thing. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/image */ - public function subjectOf($subjectOf) + public function image($image) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('image', $image); } /** - * URL of the item. + * A flag to signal that the item, event, or place is accessible for free. * - * @param string|string[] $url + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/url + * @see http://schema.org/isAccessibleForFree */ - public function url($url) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('url', $url); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * An intended audience, i.e. a group for whom something was created. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param Audience|Audience[] $audience + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/isicV4 */ - public function audience($audience) + public function isicV4($isicV4) { - return $this->setProperty('audience', $audience); + return $this->setProperty('isicV4', $isicV4); } /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Language|Language[]|string|string[] $availableLanguage + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/availableLanguage + * @see http://schema.org/latitude */ - public function availableLanguage($availableLanguage) + public function latitude($latitude) { - return $this->setProperty('availableLanguage', $availableLanguage); + return $this->setProperty('latitude', $latitude); } /** - * The earliest someone may check into a lodging establishment. + * The official name of the organization, e.g. the registered company name. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/checkinTime + * @see http://schema.org/legalName */ - public function checkinTime($checkinTime) + public function legalName($legalName) { - return $this->setProperty('checkinTime', $checkinTime); + return $this->setProperty('legalName', $legalName); } /** - * The latest someone may check out of a lodging establishment. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/checkoutTime + * @see http://schema.org/leiCode */ - public function checkoutTime($checkoutTime) + public function leiCode($leiCode) { - return $this->setProperty('checkoutTime', $checkoutTime); + return $this->setProperty('leiCode', $leiCode); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/location */ - public function numberOfRooms($numberOfRooms) + public function location($location) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('location', $location); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * An associated logo. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/logo */ - public function petsAllowed($petsAllowed) + public function logo($logo) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('logo', $logo); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Rating|Rating[] $starRating + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/longitude */ - public function starRating($starRating) + public function longitude($longitude) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('longitude', $longitude); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Organization|Organization[] $branchOf + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/mainEntityOfPage */ - public function branchOf($branchOf) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * A pointer to products or services offered by the organization or person. * - * @param string|string[] $currenciesAccepted + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/makesOffer */ - public function currenciesAccepted($currenciesAccepted) + public function makesOffer($makesOffer) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('makesOffer', $makesOffer); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * A URL to a map of the place. * - * @param string|string[] $paymentAccepted + * @param string|string[] $map * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/map */ - public function paymentAccepted($paymentAccepted) + public function map($map) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('map', $map); } /** - * The price range of the business, for example ```$$$```. + * A URL to a map of the place. * - * @param string|string[] $priceRange + * @param string|string[] $maps * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/maps */ - public function priceRange($priceRange) + public function maps($maps) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('maps', $maps); } /** - * The geographic area where a service or offered item is provided. + * The total number of individuals that may attend an event or venue. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/maximumAttendeeCapacity */ - public function areaServed($areaServed) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * An award won by or for this item. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param string|string[] $award + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/award + * @see http://schema.org/member */ - public function award($award) + public function member($member) { - return $this->setProperty('award', $award); + return $this->setProperty('member', $member); } /** - * Awards won by or for this item. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $awards + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/memberOf */ - public function awards($awards) + public function memberOf($memberOf) { - return $this->setProperty('awards', $awards); + return $this->setProperty('memberOf', $memberOf); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * A member of this organization. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/members */ - public function brand($brand) + public function members($members) { - return $this->setProperty('brand', $brand); + return $this->setProperty('members', $members); } /** - * A contact point for a person or organization. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param string|string[] $naics * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/naics */ - public function contactPoint($contactPoint) + public function naics($naics) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('naics', $naics); } /** - * A contact point for a person or organization. + * The name of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $name * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/name */ - public function contactPoints($contactPoints) + public function name($name) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('name', $name); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * The number of employees in an organization e.g. business. * - * @param Organization|Organization[] $department + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/department + * @see http://schema.org/numberOfEmployees */ - public function department($department) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('department', $department); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * The date that this organization was dissolved. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/dissolutionDate + * @see http://schema.org/numberOfRooms */ - public function dissolutionDate($dissolutionDate) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('dissolutionDate', $dissolutionDate); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * The Dun & Bradstreet DUNS number for identifying an organization or - * business person. + * A pointer to the organization or person making the offer. * - * @param string|string[] $duns + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/duns - */ - public function duns($duns) - { - return $this->setProperty('duns', $duns); - } - - /** - * Email address. - * - * @param string|string[] $email - * - * @return static - * - * @see http://schema.org/email + * @see http://schema.org/offeredBy */ - public function email($email) + public function offeredBy($offeredBy) { - return $this->setProperty('email', $email); + return $this->setProperty('offeredBy', $offeredBy); } /** - * Someone working for this organization. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param Person|Person[] $employee + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/employee + * @see http://schema.org/openingHours */ - public function employee($employee) + public function openingHours($openingHours) { - return $this->setProperty('employee', $employee); + return $this->setProperty('openingHours', $openingHours); } /** - * People working for this organization. + * The opening hours of a certain place. * - * @param Person|Person[] $employees + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/employees + * @see http://schema.org/openingHoursSpecification */ - public function employees($employees) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('employees', $employees); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * A person who founded this organization. + * Products owned by the organization or person. * - * @param Person|Person[] $founder + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/founder + * @see http://schema.org/owns */ - public function founder($founder) + public function owns($owns) { - return $this->setProperty('founder', $founder); + return $this->setProperty('owns', $owns); } /** - * A person who founded this organization. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param Person|Person[] $founders + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/founders + * @see http://schema.org/parentOrganization */ - public function founders($founders) + public function parentOrganization($parentOrganization) { - return $this->setProperty('founders', $founders); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The date that this organization was founded. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/foundingDate + * @see http://schema.org/paymentAccepted */ - public function foundingDate($foundingDate) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('foundingDate', $foundingDate); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * The place where the Organization was founded. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param Place|Place[] $foundingLocation + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/foundingLocation + * @see http://schema.org/petsAllowed */ - public function foundingLocation($foundingLocation) + public function petsAllowed($petsAllowed) { - return $this->setProperty('foundingLocation', $foundingLocation); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * A person or organization that supports (sponsors) something through some - * kind of financial contribution. + * A photograph of this place. * - * @param Organization|Organization[]|Person|Person[] $funder + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/funder + * @see http://schema.org/photo */ - public function funder($funder) + public function photo($photo) { - return $this->setProperty('funder', $funder); + return $this->setProperty('photo', $photo); } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * Photographs of this place. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/photos */ - public function hasOfferCatalog($hasOfferCatalog) + public function photos($photos) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('photos', $photos); } /** - * Points-of-Sales operated by the organization or person. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Place|Place[] $hasPOS + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/hasPOS + * @see http://schema.org/potentialAction */ - public function hasPOS($hasPOS) + public function potentialAction($potentialAction) { - return $this->setProperty('hasPOS', $hasPOS); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The official name of the organization, e.g. the registered company name. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $legalName + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/priceRange */ - public function legalName($legalName) + public function priceRange($priceRange) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('priceRange', $priceRange); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $leiCode + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/publicAccess */ - public function leiCode($leiCode) + public function publicAccess($publicAccess) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/location + * @see http://schema.org/publishingPrinciples */ - public function location($location) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('location', $location); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * A pointer to products or services offered by the organization or person. + * A review of the item. * - * @param Offer|Offer[] $makesOffer + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/review */ - public function makesOffer($makesOffer) + public function review($review) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('review', $review); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * Review of the item. * - * @param Organization|Organization[]|Person|Person[] $member + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/member + * @see http://schema.org/reviews */ - public function member($member) + public function reviews($reviews) { - return $this->setProperty('member', $member); + return $this->setProperty('reviews', $reviews); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * 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. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/sameAs */ - public function memberOf($memberOf) + public function sameAs($sameAs) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('sameAs', $sameAs); } /** - * A member of this organization. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param Organization|Organization[]|Person|Person[] $members + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/members + * @see http://schema.org/seeks */ - public function members($members) + public function seeks($seeks) { - return $this->setProperty('members', $members); + return $this->setProperty('seeks', $seeks); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The geographic area where the service is provided. * - * @param string|string[] $naics + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/serviceArea */ - public function naics($naics) + public function serviceArea($serviceArea) { - return $this->setProperty('naics', $naics); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The number of employees in an organization e.g. business. + * A slogan or motto associated with the item. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/slogan */ - public function numberOfEmployees($numberOfEmployees) + public function slogan($slogan) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('slogan', $slogan); } /** - * A pointer to the organization or person making the offer. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/smokingAllowed */ - public function offeredBy($offeredBy) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Products owned by the organization or person. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/specialOpeningHoursSpecification */ - public function owns($owns) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('owns', $owns); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * 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. * - * @param Organization|Organization[] $parentOrganization + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/sponsor */ - public function parentOrganization($parentOrganization) + public function sponsor($sponsor) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('sponsor', $sponsor); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/starRating */ - public function publishingPrinciples($publishingPrinciples) + public function starRating($starRating) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('starRating', $starRating); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param Demand|Demand[] $seeks + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/subOrganization */ - public function seeks($seeks) + public function subOrganization($subOrganization) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('subOrganization', $subOrganization); } /** - * The geographic area where the service is provided. + * A CreativeWork or Event about this Thing. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/subjectOf */ - public function serviceArea($serviceArea) + public function subjectOf($subjectOf) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/taxID */ - public function sponsor($sponsor) + public function taxID($taxID) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('taxID', $taxID); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * The telephone number. * - * @param Organization|Organization[] $subOrganization + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/telephone */ - public function subOrganization($subOrganization) + public function telephone($telephone) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('telephone', $telephone); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * URL of the item. * - * @param string|string[] $taxID + * @param string|string[] $url * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/url */ - public function taxID($taxID) + public function url($url) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('url', $url); } /** diff --git a/src/CampingPitch.php b/src/CampingPitch.php index b126c813c..05cd96ae6 100644 --- a/src/CampingPitch.php +++ b/src/CampingPitch.php @@ -31,133 +31,104 @@ class CampingPitch extends BaseType implements AccommodationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard - * - * @param QuantitativeValue|QuantitativeValue[] $floorSize - * - * @return static - * - * @see http://schema.org/floorSize - */ - public function floorSize($floorSize) - { - return $this->setProperty('floorSize', $floorSize); - } - - /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/additionalProperty */ - public function numberOfRooms($numberOfRooms) + public function additionalProperty($additionalProperty) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Indications regarding the permitted usage of the accommodation. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $permittedUsage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/permittedUsage + * @see http://schema.org/additionalType */ - public function permittedUsage($permittedUsage) + public function additionalType($additionalType) { - return $this->setProperty('permittedUsage', $permittedUsage); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * Physical address of the item. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/address */ - public function petsAllowed($petsAllowed) + public function address($address) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('address', $address); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/aggregateRating */ - public function additionalProperty($additionalProperty) + public function aggregateRating($aggregateRating) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -223,6 +194,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -266,6 +268,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -311,6 +329,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -385,6 +436,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -428,320 +495,253 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * A review of the item. + * The name of the item. * - * @param Review|Review[] $review + * @param string|string[] $name * * @return static * - * @see http://schema.org/review + * @see http://schema.org/name */ - public function review($review) + public function name($name) { - return $this->setProperty('review', $review); + return $this->setProperty('name', $name); } /** - * Review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/numberOfRooms */ - public function reviews($reviews) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Canal.php b/src/Canal.php index 0b16fa6ae..76a48658a 100644 --- a/src/Canal.php +++ b/src/Canal.php @@ -37,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -66,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -146,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -234,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -308,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -350,6 +463,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -392,6 +519,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -435,6 +577,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -482,189 +640,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/CancelAction.php b/src/CancelAction.php index 2f648d76b..c867582cd 100644 --- a/src/CancelAction.php +++ b/src/CancelAction.php @@ -20,31 +20,36 @@ class CancelAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract { /** - * The time the object is scheduled to. + * Indicates the current disposition of the Action. * - * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/scheduledTime + * @see http://schema.org/actionStatus */ - public function scheduledTime($scheduledTime) + public function actionStatus($actionStatus) { - return $this->setProperty('scheduledTime', $scheduledTime); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -63,325 +68,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The time the object is scheduled to. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/scheduledTime */ - public function name($name) + public function scheduledTime($scheduledTime) { - return $this->setProperty('name', $name); + return $this->setProperty('scheduledTime', $scheduledTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Car.php b/src/Car.php index 308da22b6..07a070435 100644 --- a/src/Car.php +++ b/src/Car.php @@ -15,549 +15,321 @@ class Car extends BaseType implements VehicleContract, ProductContract, ThingContract { /** - * The available volume for cargo or luggage. For automobiles, this is - * usually the trunk volume. - * - * Typical unit code(s): LTR for liters, FTQ for cubic foot/feet - * - * Note: You can use [[minValue]] and [[maxValue]] to indicate ranges. - * - * @param QuantitativeValue|QuantitativeValue[] $cargoVolume - * - * @return static - * - * @see http://schema.org/cargoVolume - */ - public function cargoVolume($cargoVolume) - { - return $this->setProperty('cargoVolume', $cargoVolume); - } - - /** - * The date of the first registration of the vehicle with the respective - * public authorities. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateVehicleFirstRegistered - * - * @return static - * - * @see http://schema.org/dateVehicleFirstRegistered - */ - public function dateVehicleFirstRegistered($dateVehicleFirstRegistered) - { - return $this->setProperty('dateVehicleFirstRegistered', $dateVehicleFirstRegistered); - } - - /** - * The drive wheel configuration, i.e. which roadwheels will receive torque - * from the vehicle's engine via the drivetrain. - * - * @param DriveWheelConfigurationValue|DriveWheelConfigurationValue[]|string|string[] $driveWheelConfiguration - * - * @return static - * - * @see http://schema.org/driveWheelConfiguration - */ - public function driveWheelConfiguration($driveWheelConfiguration) - { - return $this->setProperty('driveWheelConfiguration', $driveWheelConfiguration); - } - - /** - * The amount of fuel consumed for traveling a particular distance or - * temporal duration with the given vehicle (e.g. liters per 100 km). + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * * Note 1: There are unfortunately no standard unit codes for liters per - * 100 km. Use [[unitText]] to indicate the unit of measurement, e.g. L/100 - * km. - * * Note 2: There are two ways of indicating the fuel consumption, - * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] - * (e.g. 30 miles per gallon). They are reciprocal. - * * Note 3: Often, the absolute value is useful only when related to - * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can - * use [[valueReference]] to link the value for the fuel consumption to - * another value. + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[] $fuelConsumption + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/fuelConsumption + * @see http://schema.org/additionalProperty */ - public function fuelConsumption($fuelConsumption) + public function additionalProperty($additionalProperty) { - return $this->setProperty('fuelConsumption', $fuelConsumption); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The distance traveled per unit of fuel used; most commonly miles per - * gallon (mpg) or kilometers per liter (km/L). - * - * * Note 1: There are unfortunately no standard unit codes for miles per - * gallon or kilometers per liter. Use [[unitText]] to indicate the unit of - * measurement, e.g. mpg or km/L. - * * Note 2: There are two ways of indicating the fuel consumption, - * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] - * (e.g. 30 miles per gallon). They are reciprocal. - * * Note 3: Often, the absolute value is useful only when related to - * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can - * use [[valueReference]] to link the value for the fuel economy to another - * value. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[] $fuelEfficiency + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/fuelEfficiency + * @see http://schema.org/additionalType */ - public function fuelEfficiency($fuelEfficiency) + public function additionalType($additionalType) { - return $this->setProperty('fuelEfficiency', $fuelEfficiency); + return $this->setProperty('additionalType', $additionalType); } /** - * The type of fuel suitable for the engine or engines of the vehicle. If - * the vehicle has only one engine, this property can be attached directly - * to the vehicle. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param QualitativeValue|QualitativeValue[]|string|string[] $fuelType + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/fuelType + * @see http://schema.org/aggregateRating */ - public function fuelType($fuelType) + public function aggregateRating($aggregateRating) { - return $this->setProperty('fuelType', $fuelType); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * A textual description of known damages, both repaired and unrepaired. + * An alias for the item. * - * @param string|string[] $knownVehicleDamages + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/knownVehicleDamages + * @see http://schema.org/alternateName */ - public function knownVehicleDamages($knownVehicleDamages) + public function alternateName($alternateName) { - return $this->setProperty('knownVehicleDamages', $knownVehicleDamages); + return $this->setProperty('alternateName', $alternateName); } /** - * The total distance travelled by the particular vehicle since its initial - * production, as read from its odometer. - * - * Typical unit code(s): KMT for kilometers, SMI for statute miles + * An intended audience, i.e. a group for whom something was created. * - * @param QuantitativeValue|QuantitativeValue[] $mileageFromOdometer + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/mileageFromOdometer + * @see http://schema.org/audience */ - public function mileageFromOdometer($mileageFromOdometer) + public function audience($audience) { - return $this->setProperty('mileageFromOdometer', $mileageFromOdometer); + return $this->setProperty('audience', $audience); } /** - * The number or type of airbags in the vehicle. + * An award won by or for this item. * - * @param float|float[]|int|int[]|string|string[] $numberOfAirbags + * @param string|string[] $award * * @return static * - * @see http://schema.org/numberOfAirbags + * @see http://schema.org/award */ - public function numberOfAirbags($numberOfAirbags) + public function award($award) { - return $this->setProperty('numberOfAirbags', $numberOfAirbags); + return $this->setProperty('award', $award); } /** - * The number of axles. - * - * Typical unit code(s): C62 + * Awards won by or for this item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfAxles + * @param string|string[] $awards * * @return static * - * @see http://schema.org/numberOfAxles + * @see http://schema.org/awards */ - public function numberOfAxles($numberOfAxles) + public function awards($awards) { - return $this->setProperty('numberOfAxles', $numberOfAxles); + return $this->setProperty('awards', $awards); } /** - * The number of doors. - * - * Typical unit code(s): C62 + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfDoors + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/numberOfDoors + * @see http://schema.org/brand */ - public function numberOfDoors($numberOfDoors) + public function brand($brand) { - return $this->setProperty('numberOfDoors', $numberOfDoors); + return $this->setProperty('brand', $brand); } /** - * The total number of forward gears available for the transmission system - * of the vehicle. + * The available volume for cargo or luggage. For automobiles, this is + * usually the trunk volume. * - * Typical unit code(s): C62 - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfForwardGears - * - * @return static - * - * @see http://schema.org/numberOfForwardGears - */ - public function numberOfForwardGears($numberOfForwardGears) - { - return $this->setProperty('numberOfForwardGears', $numberOfForwardGears); - } - - /** - * The number of owners of the vehicle, including the current one. + * Typical unit code(s): LTR for liters, FTQ for cubic foot/feet * - * Typical unit code(s): C62 - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfPreviousOwners - * - * @return static - * - * @see http://schema.org/numberOfPreviousOwners - */ - public function numberOfPreviousOwners($numberOfPreviousOwners) - { - return $this->setProperty('numberOfPreviousOwners', $numberOfPreviousOwners); - } - - /** - * The date of production of the item, e.g. vehicle. - * - * @param \DateTimeInterface|\DateTimeInterface[] $productionDate - * - * @return static - * - * @see http://schema.org/productionDate - */ - public function productionDate($productionDate) - { - return $this->setProperty('productionDate', $productionDate); - } - - /** - * The date the item e.g. vehicle was purchased by the current owner. - * - * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate - * - * @return static - * - * @see http://schema.org/purchaseDate - */ - public function purchaseDate($purchaseDate) - { - return $this->setProperty('purchaseDate', $purchaseDate); - } - - /** - * The position of the steering wheel or similar device (mostly for cars). - * - * @param SteeringPositionValue|SteeringPositionValue[] $steeringPosition - * - * @return static - * - * @see http://schema.org/steeringPosition - */ - public function steeringPosition($steeringPosition) - { - return $this->setProperty('steeringPosition', $steeringPosition); - } - - /** - * A short text indicating the configuration of the vehicle, e.g. '5dr - * hatchback ST 2.5 MT 225 hp' or 'limited edition'. - * - * @param string|string[] $vehicleConfiguration - * - * @return static - * - * @see http://schema.org/vehicleConfiguration - */ - public function vehicleConfiguration($vehicleConfiguration) - { - return $this->setProperty('vehicleConfiguration', $vehicleConfiguration); - } - - /** - * Information about the engine or engines of the vehicle. + * Note: You can use [[minValue]] and [[maxValue]] to indicate ranges. * - * @param EngineSpecification|EngineSpecification[] $vehicleEngine + * @param QuantitativeValue|QuantitativeValue[] $cargoVolume * * @return static * - * @see http://schema.org/vehicleEngine + * @see http://schema.org/cargoVolume */ - public function vehicleEngine($vehicleEngine) + public function cargoVolume($cargoVolume) { - return $this->setProperty('vehicleEngine', $vehicleEngine); + return $this->setProperty('cargoVolume', $cargoVolume); } /** - * The Vehicle Identification Number (VIN) is a unique serial number used by - * the automotive industry to identify individual motor vehicles. + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. * - * @param string|string[] $vehicleIdentificationNumber + * @param Thing|Thing[]|string|string[] $category * * @return static * - * @see http://schema.org/vehicleIdentificationNumber + * @see http://schema.org/category */ - public function vehicleIdentificationNumber($vehicleIdentificationNumber) + public function category($category) { - return $this->setProperty('vehicleIdentificationNumber', $vehicleIdentificationNumber); + return $this->setProperty('category', $category); } /** - * The color or color combination of the interior of the vehicle. + * The color of the product. * - * @param string|string[] $vehicleInteriorColor + * @param string|string[] $color * * @return static * - * @see http://schema.org/vehicleInteriorColor + * @see http://schema.org/color */ - public function vehicleInteriorColor($vehicleInteriorColor) + public function color($color) { - return $this->setProperty('vehicleInteriorColor', $vehicleInteriorColor); + return $this->setProperty('color', $color); } /** - * The type or material of the interior of the vehicle (e.g. synthetic - * fabric, leather, wood, etc.). While most interior types are characterized - * by the material used, an interior type can also be based on vehicle usage - * or target audience. + * The date of the first registration of the vehicle with the respective + * public authorities. * - * @param string|string[] $vehicleInteriorType + * @param \DateTimeInterface|\DateTimeInterface[] $dateVehicleFirstRegistered * * @return static * - * @see http://schema.org/vehicleInteriorType + * @see http://schema.org/dateVehicleFirstRegistered */ - public function vehicleInteriorType($vehicleInteriorType) + public function dateVehicleFirstRegistered($dateVehicleFirstRegistered) { - return $this->setProperty('vehicleInteriorType', $vehicleInteriorType); + return $this->setProperty('dateVehicleFirstRegistered', $dateVehicleFirstRegistered); } /** - * The release date of a vehicle model (often used to differentiate versions - * of the same make and model). + * The depth of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $vehicleModelDate + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth * * @return static * - * @see http://schema.org/vehicleModelDate + * @see http://schema.org/depth */ - public function vehicleModelDate($vehicleModelDate) + public function depth($depth) { - return $this->setProperty('vehicleModelDate', $vehicleModelDate); + return $this->setProperty('depth', $depth); } /** - * The number of passengers that can be seated in the vehicle, both in terms - * of the physical space available, and in terms of limitations set by law. - * - * Typical unit code(s): C62 for persons. + * A description of the item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $vehicleSeatingCapacity + * @param string|string[] $description * * @return static * - * @see http://schema.org/vehicleSeatingCapacity + * @see http://schema.org/description */ - public function vehicleSeatingCapacity($vehicleSeatingCapacity) + public function description($description) { - return $this->setProperty('vehicleSeatingCapacity', $vehicleSeatingCapacity); + return $this->setProperty('description', $description); } /** - * Indicates whether the vehicle has been used for special purposes, like - * commercial rental, driving school, or as a taxi. The legislation in many - * countries requires this information to be revealed when offering a car - * for sale. + * 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. * - * @param string|string[] $vehicleSpecialUsage + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/vehicleSpecialUsage + * @see http://schema.org/disambiguatingDescription */ - public function vehicleSpecialUsage($vehicleSpecialUsage) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('vehicleSpecialUsage', $vehicleSpecialUsage); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The type of component used for transmitting the power from a rotating - * power source to the wheels or other relevant component(s) ("gearbox" for - * cars). + * The drive wheel configuration, i.e. which roadwheels will receive torque + * from the vehicle's engine via the drivetrain. * - * @param QualitativeValue|QualitativeValue[]|string|string[] $vehicleTransmission + * @param DriveWheelConfigurationValue|DriveWheelConfigurationValue[]|string|string[] $driveWheelConfiguration * * @return static * - * @see http://schema.org/vehicleTransmission + * @see http://schema.org/driveWheelConfiguration */ - public function vehicleTransmission($vehicleTransmission) + public function driveWheelConfiguration($driveWheelConfiguration) { - return $this->setProperty('vehicleTransmission', $vehicleTransmission); + return $this->setProperty('driveWheelConfiguration', $driveWheelConfiguration); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. + * The amount of fuel consumed for traveling a particular distance or + * temporal duration with the given vehicle (e.g. liters per 100 km). * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty - * - * @return static - * - * @see http://schema.org/additionalProperty - */ - public function additionalProperty($additionalProperty) - { - return $this->setProperty('additionalProperty', $additionalProperty); - } - - /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. - * - * @param AggregateRating|AggregateRating[] $aggregateRating - * - * @return static - * - * @see http://schema.org/aggregateRating - */ - public function aggregateRating($aggregateRating) - { - return $this->setProperty('aggregateRating', $aggregateRating); - } - - /** - * An intended audience, i.e. a group for whom something was created. - * - * @param Audience|Audience[] $audience - * - * @return static - * - * @see http://schema.org/audience - */ - public function audience($audience) - { - return $this->setProperty('audience', $audience); - } - - /** - * An award won by or for this item. - * - * @param string|string[] $award - * - * @return static - * - * @see http://schema.org/award - */ - public function award($award) - { - return $this->setProperty('award', $award); - } - - /** - * Awards won by or for this item. - * - * @param string|string[] $awards - * - * @return static - * - * @see http://schema.org/awards - */ - public function awards($awards) - { - return $this->setProperty('awards', $awards); - } - - /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. - * - * @param Brand|Brand[]|Organization|Organization[] $brand - * - * @return static - * - * @see http://schema.org/brand - */ - public function brand($brand) - { - return $this->setProperty('brand', $brand); - } - - /** - * A category for the item. Greater signs or slashes can be used to - * informally indicate a category hierarchy. + * * Note 1: There are unfortunately no standard unit codes for liters per + * 100 km. Use [[unitText]] to indicate the unit of measurement, e.g. L/100 + * km. + * * Note 2: There are two ways of indicating the fuel consumption, + * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] + * (e.g. 30 miles per gallon). They are reciprocal. + * * Note 3: Often, the absolute value is useful only when related to + * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can + * use [[valueReference]] to link the value for the fuel consumption to + * another value. * - * @param Thing|Thing[]|string|string[] $category + * @param QuantitativeValue|QuantitativeValue[] $fuelConsumption * * @return static * - * @see http://schema.org/category + * @see http://schema.org/fuelConsumption */ - public function category($category) + public function fuelConsumption($fuelConsumption) { - return $this->setProperty('category', $category); + return $this->setProperty('fuelConsumption', $fuelConsumption); } /** - * The color of the product. + * The distance traveled per unit of fuel used; most commonly miles per + * gallon (mpg) or kilometers per liter (km/L). + * + * * Note 1: There are unfortunately no standard unit codes for miles per + * gallon or kilometers per liter. Use [[unitText]] to indicate the unit of + * measurement, e.g. mpg or km/L. + * * Note 2: There are two ways of indicating the fuel consumption, + * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] + * (e.g. 30 miles per gallon). They are reciprocal. + * * Note 3: Often, the absolute value is useful only when related to + * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can + * use [[valueReference]] to link the value for the fuel economy to another + * value. * - * @param string|string[] $color + * @param QuantitativeValue|QuantitativeValue[] $fuelEfficiency * * @return static * - * @see http://schema.org/color + * @see http://schema.org/fuelEfficiency */ - public function color($color) + public function fuelEfficiency($fuelEfficiency) { - return $this->setProperty('color', $color); + return $this->setProperty('fuelEfficiency', $fuelEfficiency); } /** - * The depth of the item. + * The type of fuel suitable for the engine or engines of the vehicle. If + * the vehicle has only one engine, this property can be attached directly + * to the vehicle. * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth + * @param QualitativeValue|QualitativeValue[]|string|string[] $fuelType * * @return static * - * @see http://schema.org/depth + * @see http://schema.org/fuelType */ - public function depth($depth) + public function fuelType($fuelType) { - return $this->setProperty('depth', $depth); + return $this->setProperty('fuelType', $fuelType); } /** @@ -647,6 +419,39 @@ public function height($height) return $this->setProperty('height', $height); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another product (or multiple products) for which this * product is an accessory or spare part. @@ -722,6 +527,20 @@ public function itemCondition($itemCondition) return $this->setProperty('itemCondition', $itemCondition); } + /** + * A textual description of known damages, both repaired and unrepaired. + * + * @param string|string[] $knownVehicleDamages + * + * @return static + * + * @see http://schema.org/knownVehicleDamages + */ + public function knownVehicleDamages($knownVehicleDamages) + { + return $this->setProperty('knownVehicleDamages', $knownVehicleDamages); + } + /** * An associated logo. * @@ -736,6 +555,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The manufacturer of the product. * @@ -745,88 +580,241 @@ public function logo($logo) * * @see http://schema.org/manufacturer */ - public function manufacturer($manufacturer) + public function manufacturer($manufacturer) + { + return $this->setProperty('manufacturer', $manufacturer); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * The total distance travelled by the particular vehicle since its initial + * production, as read from its odometer. + * + * Typical unit code(s): KMT for kilometers, SMI for statute miles + * + * @param QuantitativeValue|QuantitativeValue[] $mileageFromOdometer + * + * @return static + * + * @see http://schema.org/mileageFromOdometer + */ + public function mileageFromOdometer($mileageFromOdometer) + { + return $this->setProperty('mileageFromOdometer', $mileageFromOdometer); + } + + /** + * The model of the product. Use with the URL of a ProductModel or a textual + * representation of the model identifier. The URL of the ProductModel can + * be from an external source. It is recommended to additionally provide + * strong product identifiers via the gtin8/gtin13/gtin14 and mpn + * properties. + * + * @param ProductModel|ProductModel[]|string|string[] $model + * + * @return static + * + * @see http://schema.org/model + */ + public function model($model) + { + return $this->setProperty('model', $model); + } + + /** + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. + * + * @param string|string[] $mpn + * + * @return static + * + * @see http://schema.org/mpn + */ + public function mpn($mpn) + { + return $this->setProperty('mpn', $mpn); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number or type of airbags in the vehicle. + * + * @param float|float[]|int|int[]|string|string[] $numberOfAirbags + * + * @return static + * + * @see http://schema.org/numberOfAirbags + */ + public function numberOfAirbags($numberOfAirbags) + { + return $this->setProperty('numberOfAirbags', $numberOfAirbags); + } + + /** + * The number of axles. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfAxles + * + * @return static + * + * @see http://schema.org/numberOfAxles + */ + public function numberOfAxles($numberOfAxles) + { + return $this->setProperty('numberOfAxles', $numberOfAxles); + } + + /** + * The number of doors. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfDoors + * + * @return static + * + * @see http://schema.org/numberOfDoors + */ + public function numberOfDoors($numberOfDoors) + { + return $this->setProperty('numberOfDoors', $numberOfDoors); + } + + /** + * The total number of forward gears available for the transmission system + * of the vehicle. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfForwardGears + * + * @return static + * + * @see http://schema.org/numberOfForwardGears + */ + public function numberOfForwardGears($numberOfForwardGears) + { + return $this->setProperty('numberOfForwardGears', $numberOfForwardGears); + } + + /** + * The number of owners of the vehicle, including the current one. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfPreviousOwners + * + * @return static + * + * @see http://schema.org/numberOfPreviousOwners + */ + public function numberOfPreviousOwners($numberOfPreviousOwners) { - return $this->setProperty('manufacturer', $manufacturer); + return $this->setProperty('numberOfPreviousOwners', $numberOfPreviousOwners); } /** - * A material that something is made from, e.g. leather, wool, cotton, - * paper. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param Product|Product[]|string|string[] $material + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/material + * @see http://schema.org/offers */ - public function material($material) + public function offers($offers) { - return $this->setProperty('material', $material); + return $this->setProperty('offers', $offers); } /** - * The model of the product. Use with the URL of a ProductModel or a textual - * representation of the model identifier. The URL of the ProductModel can - * be from an external source. It is recommended to additionally provide - * strong product identifiers via the gtin8/gtin13/gtin14 and mpn - * properties. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ProductModel|ProductModel[]|string|string[] $model + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/model + * @see http://schema.org/potentialAction */ - public function model($model) + public function potentialAction($potentialAction) { - return $this->setProperty('model', $model); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The Manufacturer Part Number (MPN) of the product, or the product to - * which the offer refers. + * The product identifier, such as ISBN. For example: ``` meta + * itemprop="productID" content="isbn:123-456-789" ```. * - * @param string|string[] $mpn + * @param string|string[] $productID * * @return static * - * @see http://schema.org/mpn + * @see http://schema.org/productID */ - public function mpn($mpn) + public function productID($productID) { - return $this->setProperty('mpn', $mpn); + return $this->setProperty('productID', $productID); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * The date of production of the item, e.g. vehicle. * - * @param Offer|Offer[] $offers + * @param \DateTimeInterface|\DateTimeInterface[] $productionDate * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/productionDate */ - public function offers($offers) + public function productionDate($productionDate) { - return $this->setProperty('offers', $offers); + return $this->setProperty('productionDate', $productionDate); } /** - * The product identifier, such as ISBN. For example: ``` meta - * itemprop="productID" content="isbn:123-456-789" ```. + * The date the item e.g. vehicle was purchased by the current owner. * - * @param string|string[] $productID + * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate * * @return static * - * @see http://schema.org/productID + * @see http://schema.org/purchaseDate */ - public function productID($productID) + public function purchaseDate($purchaseDate) { - return $this->setProperty('productID', $productID); + return $this->setProperty('purchaseDate', $purchaseDate); } /** @@ -872,6 +860,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a * product or service, or the product to which the offer refers. @@ -902,217 +906,213 @@ public function slogan($slogan) } /** - * The weight of the product or person. + * The position of the steering wheel or similar device (mostly for cars). * - * @param QuantitativeValue|QuantitativeValue[] $weight + * @param SteeringPositionValue|SteeringPositionValue[] $steeringPosition * * @return static * - * @see http://schema.org/weight + * @see http://schema.org/steeringPosition */ - public function weight($weight) + public function steeringPosition($steeringPosition) { - return $this->setProperty('weight', $weight); + return $this->setProperty('steeringPosition', $steeringPosition); } /** - * The width of the item. + * A CreativeWork or Event about this Thing. * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/width + * @see http://schema.org/subjectOf */ - public function width($width) + public function subjectOf($subjectOf) { - return $this->setProperty('width', $width); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * URL of the item. * - * @param string|string[] $additionalType + * @param string|string[] $url * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/url */ - public function additionalType($additionalType) + public function url($url) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('url', $url); } /** - * An alias for the item. + * A short text indicating the configuration of the vehicle, e.g. '5dr + * hatchback ST 2.5 MT 225 hp' or 'limited edition'. * - * @param string|string[] $alternateName + * @param string|string[] $vehicleConfiguration * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/vehicleConfiguration */ - public function alternateName($alternateName) + public function vehicleConfiguration($vehicleConfiguration) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('vehicleConfiguration', $vehicleConfiguration); } /** - * A description of the item. + * Information about the engine or engines of the vehicle. * - * @param string|string[] $description + * @param EngineSpecification|EngineSpecification[] $vehicleEngine * * @return static * - * @see http://schema.org/description + * @see http://schema.org/vehicleEngine */ - public function description($description) + public function vehicleEngine($vehicleEngine) { - return $this->setProperty('description', $description); + return $this->setProperty('vehicleEngine', $vehicleEngine); } /** - * 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. + * The Vehicle Identification Number (VIN) is a unique serial number used by + * the automotive industry to identify individual motor vehicles. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $vehicleIdentificationNumber * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/vehicleIdentificationNumber */ - public function disambiguatingDescription($disambiguatingDescription) + public function vehicleIdentificationNumber($vehicleIdentificationNumber) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('vehicleIdentificationNumber', $vehicleIdentificationNumber); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The color or color combination of the interior of the vehicle. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $vehicleInteriorColor * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/vehicleInteriorColor */ - public function identifier($identifier) + public function vehicleInteriorColor($vehicleInteriorColor) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('vehicleInteriorColor', $vehicleInteriorColor); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The type or material of the interior of the vehicle (e.g. synthetic + * fabric, leather, wood, etc.). While most interior types are characterized + * by the material used, an interior type can also be based on vehicle usage + * or target audience. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $vehicleInteriorType * * @return static * - * @see http://schema.org/image + * @see http://schema.org/vehicleInteriorType */ - public function image($image) + public function vehicleInteriorType($vehicleInteriorType) { - return $this->setProperty('image', $image); + return $this->setProperty('vehicleInteriorType', $vehicleInteriorType); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The release date of a vehicle model (often used to differentiate versions + * of the same make and model). * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $vehicleModelDate * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/vehicleModelDate */ - public function mainEntityOfPage($mainEntityOfPage) + public function vehicleModelDate($vehicleModelDate) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('vehicleModelDate', $vehicleModelDate); } /** - * The name of the item. + * The number of passengers that can be seated in the vehicle, both in terms + * of the physical space available, and in terms of limitations set by law. + * + * Typical unit code(s): C62 for persons. * - * @param string|string[] $name + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $vehicleSeatingCapacity * * @return static * - * @see http://schema.org/name + * @see http://schema.org/vehicleSeatingCapacity */ - public function name($name) + public function vehicleSeatingCapacity($vehicleSeatingCapacity) { - return $this->setProperty('name', $name); + return $this->setProperty('vehicleSeatingCapacity', $vehicleSeatingCapacity); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates whether the vehicle has been used for special purposes, like + * commercial rental, driving school, or as a taxi. The legislation in many + * countries requires this information to be revealed when offering a car + * for sale. * - * @param Action|Action[] $potentialAction + * @param string|string[] $vehicleSpecialUsage * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/vehicleSpecialUsage */ - public function potentialAction($potentialAction) + public function vehicleSpecialUsage($vehicleSpecialUsage) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('vehicleSpecialUsage', $vehicleSpecialUsage); } /** - * 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. + * The type of component used for transmitting the power from a rotating + * power source to the wheels or other relevant component(s) ("gearbox" for + * cars). * - * @param string|string[] $sameAs + * @param QualitativeValue|QualitativeValue[]|string|string[] $vehicleTransmission * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/vehicleTransmission */ - public function sameAs($sameAs) + public function vehicleTransmission($vehicleTransmission) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('vehicleTransmission', $vehicleTransmission); } /** - * A CreativeWork or Event about this Thing. + * The weight of the product or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param QuantitativeValue|QuantitativeValue[] $weight * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/weight */ - public function subjectOf($subjectOf) + public function weight($weight) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('weight', $weight); } /** - * URL of the item. + * The width of the item. * - * @param string|string[] $url + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/url + * @see http://schema.org/width */ - public function url($url) + public function width($width) { - return $this->setProperty('url', $url); + return $this->setProperty('width', $width); } } diff --git a/src/Casino.php b/src/Casino.php index a310052fe..08344ee26 100644 --- a/src/Casino.php +++ b/src/Casino.php @@ -17,126 +17,104 @@ class Casino extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/CatholicChurch.php b/src/CatholicChurch.php index 8b7e962a3..7ce9f7cfe 100644 --- a/src/CatholicChurch.php +++ b/src/CatholicChurch.php @@ -16,35 +16,6 @@ */ class CatholicChurch extends BaseType implements ChurchContract, PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -67,6 +38,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -96,6 +86,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -176,6 +180,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -264,6 +299,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -338,6 +406,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -380,6 +464,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -422,6 +549,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -465,6 +607,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -512,189 +670,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Cemetery.php b/src/Cemetery.php index 7b3d165b2..85c21717b 100644 --- a/src/Cemetery.php +++ b/src/Cemetery.php @@ -14,35 +14,6 @@ */ class Cemetery extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/CheckAction.php b/src/CheckAction.php index 46d842f8b..8952c5983 100644 --- a/src/CheckAction.php +++ b/src/CheckAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/CheckInAction.php b/src/CheckInAction.php index 8668db273..3c1362948 100644 --- a/src/CheckInAction.php +++ b/src/CheckInAction.php @@ -42,78 +42,96 @@ public function about($about) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * Indicates the current disposition of the Action. * - * @param Language|Language[]|string|string[] $inLanguage + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/actionStatus */ - public function inLanguage($inLanguage) + public function actionStatus($actionStatus) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of instrument. The language used on this action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[] $language + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/language + * @see http://schema.org/additionalType */ - public function language($language) + public function additionalType($additionalType) { - return $this->setProperty('language', $language); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/agent */ - public function recipient($recipient) + public function agent($agent) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -154,288 +172,270 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/inLanguage */ - public function participant($participant) + public function inLanguage($inLanguage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('inLanguage', $inLanguage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of instrument. The language used on this action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/language */ - public function startTime($startTime) + public function language($language) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('language', $language); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/CheckOutAction.php b/src/CheckOutAction.php index b0523cc18..da1fe8bce 100644 --- a/src/CheckOutAction.php +++ b/src/CheckOutAction.php @@ -40,78 +40,96 @@ public function about($about) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * Indicates the current disposition of the Action. * - * @param Language|Language[]|string|string[] $inLanguage + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/actionStatus */ - public function inLanguage($inLanguage) + public function actionStatus($actionStatus) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of instrument. The language used on this action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[] $language + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/language + * @see http://schema.org/additionalType */ - public function language($language) + public function additionalType($additionalType) { - return $this->setProperty('language', $language); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/agent */ - public function recipient($recipient) + public function agent($agent) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -152,288 +170,270 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/inLanguage */ - public function participant($participant) + public function inLanguage($inLanguage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('inLanguage', $inLanguage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of instrument. The language used on this action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/language */ - public function startTime($startTime) + public function language($language) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('language', $language); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/CheckoutPage.php b/src/CheckoutPage.php index 8923ce51f..d7d374b47 100644 --- a/src/CheckoutPage.php +++ b/src/CheckoutPage.php @@ -14,176 +14,6 @@ */ class CheckoutPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -328,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -343,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -444,6 +307,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -634,6 +512,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -860,13 +769,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -996,6 +938,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1041,6 +998,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1056,6 +1027,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1086,6 +1073,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1116,6 +1117,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1214,6 +1244,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1243,6 +1287,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1257,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1274,6 +1349,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1323,6 +1428,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1339,6 +1497,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1460,6 +1632,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1503,190 +1689,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ChildCare.php b/src/ChildCare.php index b96ef26e4..8fcde1032 100644 --- a/src/ChildCare.php +++ b/src/ChildCare.php @@ -16,126 +16,104 @@ class ChildCare extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ChildrensEvent.php b/src/ChildrensEvent.php index c01ffa52f..37bb03754 100644 --- a/src/ChildrensEvent.php +++ b/src/ChildrensEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ChooseAction.php b/src/ChooseAction.php index 8b787164b..fbf865270 100644 --- a/src/ChooseAction.php +++ b/src/ChooseAction.php @@ -30,31 +30,36 @@ public function actionOption($actionOption) } /** - * A sub property of object. The options subject to this action. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[]|string|string[] $option + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/option + * @see http://schema.org/actionStatus */ - public function option($option) + public function actionStatus($actionStatus) { - return $this->setProperty('option', $option); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -73,325 +78,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * A sub property of object. The options subject to this action. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[]|string|string[] $option * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/option */ - public function disambiguatingDescription($disambiguatingDescription) + public function option($option) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('option', $option); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Church.php b/src/Church.php index 9fa363602..97f6db43d 100644 --- a/src/Church.php +++ b/src/Church.php @@ -15,35 +15,6 @@ */ class Church extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/City.php b/src/City.php index 65f43bd50..2c4757dbf 100644 --- a/src/City.php +++ b/src/City.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/CityHall.php b/src/CityHall.php index 9974aa9d2..8d658bfcd 100644 --- a/src/CityHall.php +++ b/src/CityHall.php @@ -15,35 +15,6 @@ */ class CityHall extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/CivicStructure.php b/src/CivicStructure.php index 1ee5a484b..5cc3148d2 100644 --- a/src/CivicStructure.php +++ b/src/CivicStructure.php @@ -13,35 +13,6 @@ */ class CivicStructure extends BaseType implements PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -64,6 +35,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -93,6 +83,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -173,6 +177,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -261,6 +296,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -335,6 +403,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -377,6 +461,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -419,6 +546,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -462,6 +604,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -509,189 +667,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/ClaimReview.php b/src/ClaimReview.php index 9a0dde12f..7a8853e77 100644 --- a/src/ClaimReview.php +++ b/src/ClaimReview.php @@ -15,80 +15,6 @@ */ class ClaimReview extends BaseType implements ReviewContract, CreativeWorkContract, ThingContract { - /** - * A short summary of the specific claims reviewed in a ClaimReview. - * - * @param string|string[] $claimReviewed - * - * @return static - * - * @see http://schema.org/claimReviewed - */ - public function claimReviewed($claimReviewed) - { - return $this->setProperty('claimReviewed', $claimReviewed); - } - - /** - * The item that is being reviewed/rated. - * - * @param Thing|Thing[] $itemReviewed - * - * @return static - * - * @see http://schema.org/itemReviewed - */ - public function itemReviewed($itemReviewed) - { - return $this->setProperty('itemReviewed', $itemReviewed); - } - - /** - * This Review or Rating is relevant to this part or facet of the - * itemReviewed. - * - * @param string|string[] $reviewAspect - * - * @return static - * - * @see http://schema.org/reviewAspect - */ - public function reviewAspect($reviewAspect) - { - return $this->setProperty('reviewAspect', $reviewAspect); - } - - /** - * The actual body of the review. - * - * @param string|string[] $reviewBody - * - * @return static - * - * @see http://schema.org/reviewBody - */ - public function reviewBody($reviewBody) - { - return $this->setProperty('reviewBody', $reviewBody); - } - - /** - * The rating given in this review. Note that reviews can themselves be - * rated. The ```reviewRating``` applies to rating given by the review. The - * [[aggregateRating]] property applies to the review itself, as a creative - * work. - * - * @param Rating|Rating[] $reviewRating - * - * @return static - * - * @see http://schema.org/reviewRating - */ - public function reviewRating($reviewRating) - { - return $this->setProperty('reviewRating', $reviewRating); - } - /** * The subject matter of the content. * @@ -233,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -248,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -378,6 +337,20 @@ public function citation($citation) return $this->setProperty('citation', $citation); } + /** + * A short summary of the specific claims reviewed in a ClaimReview. + * + * @param string|string[] $claimReviewed + * + * @return static + * + * @see http://schema.org/claimReviewed + */ + public function claimReviewed($claimReviewed) + { + return $this->setProperty('claimReviewed', $claimReviewed); + } + /** * Comments, typically from users. * @@ -539,6 +512,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -764,6 +768,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -886,6 +923,20 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The item that is being reviewed/rated. + * + * @param Thing|Thing[] $itemReviewed + * + * @return static + * + * @see http://schema.org/itemReviewed + */ + public function itemReviewed($itemReviewed) + { + return $this->setProperty('itemReviewed', $itemReviewed); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -961,6 +1012,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -991,6 +1058,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1021,6 +1102,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1149,21 +1245,83 @@ public function review($review) } /** - * Review of the item. + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. * - * @param Review|Review[] $reviews + * @param string|string[] $reviewAspect * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/reviewAspect */ - public function reviews($reviews) + public function reviewAspect($reviewAspect) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('reviewAspect', $reviewAspect); } /** - * Indicates (by URL or string) a particular version of a schema used in + * The actual body of the review. + * + * @param string|string[] $reviewBody + * + * @return static + * + * @see http://schema.org/reviewBody + */ + public function reviewBody($reviewBody) + { + return $this->setProperty('reviewBody', $reviewBody); + } + + /** + * The rating given in this review. Note that reviews can themselves be + * rated. The ```reviewRating``` applies to rating given by the review. The + * [[aggregateRating]] property applies to the review itself, as a creative + * work. + * + * @param Rating|Rating[] $reviewRating + * + * @return static + * + * @see http://schema.org/reviewRating + */ + public function reviewRating($reviewRating) + { + return $this->setProperty('reviewRating', $reviewRating); + } + + /** + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion * using an URL such as http://schema.org/version/2.0/ if precise indication * of schema version was required by some application. @@ -1244,6 +1402,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1365,6 +1537,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1408,190 +1594,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Clip.php b/src/Clip.php index 3dabc4654..698d07565 100644 --- a/src/Clip.php +++ b/src/Clip.php @@ -13,138 +13,6 @@ */ class Clip extends BaseType implements CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * Position of the clip within an ordered group of clips. - * - * @param int|int[]|string|string[] $clipNumber - * - * @return static - * - * @see http://schema.org/clipNumber - */ - public function clipNumber($clipNumber) - { - return $this->setProperty('clipNumber', $clipNumber); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The episode to which this clip belongs. - * - * @param Episode|Episode[] $partOfEpisode - * - * @return static - * - * @see http://schema.org/partOfEpisode - */ - public function partOfEpisode($partOfEpisode) - { - return $this->setProperty('partOfEpisode', $partOfEpisode); - } - - /** - * The season to which this episode belongs. - * - * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason - * - * @return static - * - * @see http://schema.org/partOfSeason - */ - public function partOfSeason($partOfSeason) - { - return $this->setProperty('partOfSeason', $partOfSeason); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - /** * The subject matter of the content. * @@ -289,6 +157,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -304,6 +222,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -434,6 +366,20 @@ public function citation($citation) return $this->setProperty('citation', $citation); } + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + /** * Comments, typically from users. * @@ -596,60 +542,122 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * 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. * - * @param string|string[] $educationalUse + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/disambiguatingDescription */ - public function educationalUse($educationalUse) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); } /** @@ -820,6 +828,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1017,6 +1058,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1047,6 +1104,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1063,6 +1148,48 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1077,6 +1204,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1218,6 +1360,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1300,6 +1458,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1421,6 +1593,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1464,190 +1650,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ClothingStore.php b/src/ClothingStore.php index 2c55d1e1f..8d5261557 100644 --- a/src/ClothingStore.php +++ b/src/ClothingStore.php @@ -17,126 +17,104 @@ class ClothingStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Code.php b/src/Code.php index 8ab3e2ef5..9e5796c2a 100644 --- a/src/Code.php +++ b/src/Code.php @@ -158,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -173,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -464,6 +497,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -689,6 +753,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -886,6 +983,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -916,6 +1029,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -946,6 +1073,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1087,6 +1229,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1169,6 +1327,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1290,6 +1462,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1333,190 +1519,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/CollectionPage.php b/src/CollectionPage.php index 01f700bb1..e32f8e2e5 100644 --- a/src/CollectionPage.php +++ b/src/CollectionPage.php @@ -14,176 +14,6 @@ */ class CollectionPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -328,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -343,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -444,6 +307,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -634,6 +512,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -860,13 +769,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -996,6 +938,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1041,6 +998,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1056,6 +1027,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1086,6 +1073,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1116,6 +1117,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1214,6 +1244,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1243,6 +1287,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1257,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1274,6 +1349,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1323,6 +1428,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1339,6 +1497,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1460,6 +1632,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1503,190 +1689,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/CollegeOrUniversity.php b/src/CollegeOrUniversity.php index 21833e8e4..8e80165a6 100644 --- a/src/CollegeOrUniversity.php +++ b/src/CollegeOrUniversity.php @@ -15,17 +15,22 @@ class CollegeOrUniversity extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { /** - * Alumni of an organization. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $alumni + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/alumni + * @see http://schema.org/additionalType */ - public function alumni($alumni) + public function additionalType($additionalType) { - return $this->setProperty('alumni', $alumni); + return $this->setProperty('additionalType', $additionalType); } /** @@ -57,6 +62,34 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + /** * The geographic area where a service or offered item is provided. * @@ -159,6 +192,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -390,6 +454,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -464,6 +561,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -537,6 +650,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -594,6 +721,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -646,6 +788,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -721,6 +879,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -751,203 +923,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ComedyClub.php b/src/ComedyClub.php index e41074e41..66dadc93d 100644 --- a/src/ComedyClub.php +++ b/src/ComedyClub.php @@ -17,126 +17,104 @@ class ComedyClub extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ComedyEvent.php b/src/ComedyEvent.php index 31c4bcb83..bf98f4b62 100644 --- a/src/ComedyEvent.php +++ b/src/ComedyEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Comment.php b/src/Comment.php index 674907a17..38021e830 100644 --- a/src/Comment.php +++ b/src/Comment.php @@ -15,50 +15,6 @@ */ class Comment extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The number of downvotes this question, answer or comment has received - * from the community. - * - * @param int|int[] $downvoteCount - * - * @return static - * - * @see http://schema.org/downvoteCount - */ - public function downvoteCount($downvoteCount) - { - return $this->setProperty('downvoteCount', $downvoteCount); - } - - /** - * The parent of a question, answer or item in general. - * - * @param Question|Question[] $parentItem - * - * @return static - * - * @see http://schema.org/parentItem - */ - public function parentItem($parentItem) - { - return $this->setProperty('parentItem', $parentItem); - } - - /** - * The number of upvotes this question, answer or comment has received from - * the community. - * - * @param int|int[] $upvoteCount - * - * @return static - * - * @see http://schema.org/upvoteCount - */ - public function upvoteCount($upvoteCount) - { - return $this->setProperty('upvoteCount', $upvoteCount); - } - /** * The subject matter of the content. * @@ -203,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -218,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -509,6 +498,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -523,6 +543,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The number of downvotes this question, answer or comment has received + * from the community. + * + * @param int|int[] $downvoteCount + * + * @return static + * + * @see http://schema.org/downvoteCount + */ + public function downvoteCount($downvoteCount) + { + return $this->setProperty('downvoteCount', $downvoteCount); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -734,6 +769,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -931,6 +999,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -961,6 +1045,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -977,6 +1075,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The parent of a question, answer or item in general. + * + * @param Question|Question[] $parentItem + * + * @return static + * + * @see http://schema.org/parentItem + */ + public function parentItem($parentItem) + { + return $this->setProperty('parentItem', $parentItem); + } + /** * The position of an item in a series or sequence of items. * @@ -991,6 +1103,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1132,6 +1259,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1214,6 +1357,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1336,232 +1493,75 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. + * The number of upvotes this question, answer or comment has received from + * the community. * - * @param string|string[] $name + * @param int|int[] $upvoteCount * * @return static * - * @see http://schema.org/name + * @see http://schema.org/upvoteCount */ - public function name($name) + public function upvoteCount($upvoteCount) { - return $this->setProperty('name', $name); + return $this->setProperty('upvoteCount', $upvoteCount); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The version of the CreativeWork embodied by a specified resource. * - * @param string|string[] $sameAs + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/version */ - public function sameAs($sameAs) + public function version($version) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('version', $version); } /** - * A CreativeWork or Event about this Thing. + * An embedded video object. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/video */ - public function subjectOf($subjectOf) + public function video($video) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('video', $video); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/CommentAction.php b/src/CommentAction.php index 27ca1f2d3..aeb77ce1b 100644 --- a/src/CommentAction.php +++ b/src/CommentAction.php @@ -16,107 +16,110 @@ class CommentAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** - * A sub property of result. The Comment created or sent as a result of this - * action. + * The subject matter of the content. * - * @param Comment|Comment[] $resultComment + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/resultComment + * @see http://schema.org/about */ - public function resultComment($resultComment) + public function about($about) { - return $this->setProperty('resultComment', $resultComment); + return $this->setProperty('about', $about); } /** - * The subject matter of the content. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $about + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/about + * @see http://schema.org/actionStatus */ - public function about($about) + public function actionStatus($actionStatus) { - return $this->setProperty('about', $about); + return $this->setProperty('actionStatus', $actionStatus); } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[]|string|string[] $inLanguage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/additionalType */ - public function inLanguage($inLanguage) + public function additionalType($additionalType) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of instrument. The language used on this action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Language|Language[] $language + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/language + * @see http://schema.org/agent */ - public function language($language) + public function agent($agent) { - return $this->setProperty('language', $language); + return $this->setProperty('agent', $agent); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * An alias for the item. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/alternateName */ - public function recipient($recipient) + public function alternateName($alternateName) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -157,288 +160,285 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $instrument + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/identifier */ - public function instrument($instrument) + public function identifier($identifier) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Thing|Thing[] $object + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/object + * @see http://schema.org/inLanguage */ - public function object($object) + public function inLanguage($inLanguage) { - return $this->setProperty('object', $object); + return $this->setProperty('inLanguage', $inLanguage); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/instrument */ - public function participant($participant) + public function instrument($instrument) { - return $this->setProperty('participant', $participant); + return $this->setProperty('instrument', $instrument); } /** - * The result produced in the action. e.g. John wrote *a book*. + * A sub property of instrument. The language used on this action. * - * @param Thing|Thing[] $result + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/result + * @see http://schema.org/language */ - public function result($result) + public function language($language) { - return $this->setProperty('result', $result); + return $this->setProperty('language', $language); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/recipient */ - public function identifier($identifier) + public function recipient($recipient) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('recipient', $recipient); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A sub property of result. The Comment created or sent as a result of this + * action. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Comment|Comment[] $resultComment * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/resultComment */ - public function mainEntityOfPage($mainEntityOfPage) + public function resultComment($resultComment) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('resultComment', $resultComment); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/CommunicateAction.php b/src/CommunicateAction.php index 7a24dc5b3..ef4a1f033 100644 --- a/src/CommunicateAction.php +++ b/src/CommunicateAction.php @@ -30,78 +30,96 @@ public function about($about) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * Indicates the current disposition of the Action. * - * @param Language|Language[]|string|string[] $inLanguage + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/actionStatus */ - public function inLanguage($inLanguage) + public function actionStatus($actionStatus) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of instrument. The language used on this action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[] $language + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/language + * @see http://schema.org/additionalType */ - public function language($language) + public function additionalType($additionalType) { - return $this->setProperty('language', $language); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/agent */ - public function recipient($recipient) + public function agent($agent) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -142,288 +160,270 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/inLanguage */ - public function participant($participant) + public function inLanguage($inLanguage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('inLanguage', $inLanguage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of instrument. The language used on this action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/language */ - public function startTime($startTime) + public function language($language) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('language', $language); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/CompoundPriceSpecification.php b/src/CompoundPriceSpecification.php index ce8bc2c7e..4eb0a417c 100644 --- a/src/CompoundPriceSpecification.php +++ b/src/CompoundPriceSpecification.php @@ -19,369 +19,369 @@ class CompoundPriceSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract { /** - * This property links to all [[UnitPriceSpecification]] nodes that apply in - * parallel for the [[CompoundPriceSpecification]] node. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param UnitPriceSpecification|UnitPriceSpecification[] $priceComponent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/priceComponent + * @see http://schema.org/additionalType */ - public function priceComponent($priceComponent) + public function additionalType($additionalType) { - return $this->setProperty('priceComponent', $priceComponent); + return $this->setProperty('additionalType', $additionalType); } /** - * The interval and unit of measurement of ordering quantities for which the - * offer or price specification is valid. This allows e.g. specifying that a - * certain freight charge is valid only for a certain quantity. + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/eligibleQuantity + * @see http://schema.org/alternateName */ - public function eligibleQuantity($eligibleQuantity) + public function alternateName($alternateName) { - return $this->setProperty('eligibleQuantity', $eligibleQuantity); + return $this->setProperty('alternateName', $alternateName); } /** - * The transaction volume, in a monetary unit, for which the offer or price - * specification is valid, e.g. for indicating a minimal purchasing volume, - * to express free shipping above a certain order volume, or to limit the - * acceptance of credit cards to purchases to a certain minimal amount. + * A description of the item. * - * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * @param string|string[] $description * * @return static * - * @see http://schema.org/eligibleTransactionVolume + * @see http://schema.org/description */ - public function eligibleTransactionVolume($eligibleTransactionVolume) + public function description($description) { - return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + return $this->setProperty('description', $description); } /** - * The highest price if the price is a range. + * 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. * - * @param float|float[]|int|int[] $maxPrice + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/maxPrice + * @see http://schema.org/disambiguatingDescription */ - public function maxPrice($maxPrice) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('maxPrice', $maxPrice); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The lowest price if the price is a range. + * The interval and unit of measurement of ordering quantities for which the + * offer or price specification is valid. This allows e.g. specifying that a + * certain freight charge is valid only for a certain quantity. * - * @param float|float[]|int|int[] $minPrice + * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity * * @return static * - * @see http://schema.org/minPrice + * @see http://schema.org/eligibleQuantity */ - public function minPrice($minPrice) + public function eligibleQuantity($eligibleQuantity) { - return $this->setProperty('minPrice', $minPrice); + return $this->setProperty('eligibleQuantity', $eligibleQuantity); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. * - * @param float|float[]|int|int[]|string|string[] $price + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume * * @return static * - * @see http://schema.org/price + * @see http://schema.org/eligibleTransactionVolume */ - public function price($price) + public function eligibleTransactionVolume($eligibleTransactionVolume) { - return $this->setProperty('price', $price); + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $priceCurrency + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/identifier */ - public function priceCurrency($priceCurrency) + public function identifier($identifier) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('identifier', $identifier); } /** - * The date when the item becomes valid. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/validFrom + * @see http://schema.org/image */ - public function validFrom($validFrom) + public function image($image) { - return $this->setProperty('validFrom', $validFrom); + return $this->setProperty('image', $image); } /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/validThrough + * @see http://schema.org/mainEntityOfPage */ - public function validThrough($validThrough) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('validThrough', $validThrough); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Specifies whether the applicable value-added tax (VAT) is included in the - * price specification or not. + * The highest price if the price is a range. * - * @param bool|bool[] $valueAddedTaxIncluded + * @param float|float[]|int|int[] $maxPrice * * @return static * - * @see http://schema.org/valueAddedTaxIncluded + * @see http://schema.org/maxPrice */ - public function valueAddedTaxIncluded($valueAddedTaxIncluded) + public function maxPrice($maxPrice) { - return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); + return $this->setProperty('maxPrice', $maxPrice); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The lowest price if the price is a range. * - * @param string|string[] $additionalType + * @param float|float[]|int|int[] $minPrice * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/minPrice */ - public function additionalType($additionalType) + public function minPrice($minPrice) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('minPrice', $minPrice); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $description + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/description + * @see http://schema.org/potentialAction */ - public function description($description) + public function potentialAction($potentialAction) { - return $this->setProperty('description', $description); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $disambiguatingDescription + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/price */ - public function disambiguatingDescription($disambiguatingDescription) + public function price($price) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('price', $price); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * This property links to all [[UnitPriceSpecification]] nodes that apply in + * parallel for the [[CompoundPriceSpecification]] node. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param UnitPriceSpecification|UnitPriceSpecification[] $priceComponent * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceComponent */ - public function identifier($identifier) + public function priceComponent($priceComponent) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceComponent', $priceComponent); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceCurrency */ - public function image($image) + public function priceCurrency($priceCurrency) { - return $this->setProperty('image', $image); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The date when the item becomes valid. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validFrom */ - public function sameAs($sameAs) + public function validFrom($validFrom) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validFrom', $validFrom); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. * - * @param string|string[] $url + * @param bool|bool[] $valueAddedTaxIncluded * * @return static * - * @see http://schema.org/url + * @see http://schema.org/valueAddedTaxIncluded */ - public function url($url) + public function valueAddedTaxIncluded($valueAddedTaxIncluded) { - return $this->setProperty('url', $url); + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); } } diff --git a/src/ComputerStore.php b/src/ComputerStore.php index d00e47b2a..95ac75a2f 100644 --- a/src/ComputerStore.php +++ b/src/ComputerStore.php @@ -17,126 +17,104 @@ class ComputerStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ConfirmAction.php b/src/ConfirmAction.php index 52b83ee80..c85e68909 100644 --- a/src/ConfirmAction.php +++ b/src/ConfirmAction.php @@ -22,107 +22,110 @@ class ConfirmAction extends BaseType implements InformActionContract, CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** - * Upcoming or past event associated with this place, organization, or - * action. + * The subject matter of the content. * - * @param Event|Event[] $event + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/event + * @see http://schema.org/about */ - public function event($event) + public function about($about) { - return $this->setProperty('event', $event); + return $this->setProperty('about', $about); } /** - * The subject matter of the content. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $about + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/about + * @see http://schema.org/actionStatus */ - public function about($about) + public function actionStatus($actionStatus) { - return $this->setProperty('about', $about); + return $this->setProperty('actionStatus', $actionStatus); } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[]|string|string[] $inLanguage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/additionalType */ - public function inLanguage($inLanguage) + public function additionalType($additionalType) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of instrument. The language used on this action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Language|Language[] $language + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/language + * @see http://schema.org/agent */ - public function language($language) + public function agent($agent) { - return $this->setProperty('language', $language); + return $this->setProperty('agent', $agent); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * An alias for the item. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/alternateName */ - public function recipient($recipient) + public function alternateName($alternateName) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -163,288 +166,285 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param Thing|Thing[] $instrument + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/event */ - public function instrument($instrument) + public function event($event) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('event', $event); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/inLanguage */ - public function participant($participant) + public function inLanguage($inLanguage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('inLanguage', $inLanguage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of instrument. The language used on this action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/language */ - public function startTime($startTime) + public function language($language) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('language', $language); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ConsumeAction.php b/src/ConsumeAction.php index 6d2434964..f6727926f 100644 --- a/src/ConsumeAction.php +++ b/src/ConsumeAction.php @@ -30,33 +30,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -75,325 +78,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ContactPage.php b/src/ContactPage.php index 3d82c9fd2..31bf32b1e 100644 --- a/src/ContactPage.php +++ b/src/ContactPage.php @@ -14,176 +14,6 @@ */ class ContactPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -328,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -343,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -444,6 +307,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -634,6 +512,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -860,13 +769,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -996,6 +938,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1041,6 +998,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1056,6 +1027,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1086,6 +1073,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1116,6 +1117,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1214,6 +1244,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1243,6 +1287,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1257,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1274,6 +1349,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1323,6 +1428,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1339,6 +1497,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1460,6 +1632,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1503,190 +1689,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ContactPoint.php b/src/ContactPoint.php index bad6d6a58..5cd107a29 100644 --- a/src/ContactPoint.php +++ b/src/ContactPoint.php @@ -14,6 +14,39 @@ */ class ContactPoint extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -76,154 +109,76 @@ public function contactType($contactType) } /** - * Email address. - * - * @param string|string[] $email - * - * @return static - * - * @see http://schema.org/email - */ - public function email($email) - { - return $this->setProperty('email', $email); - } - - /** - * The fax number. - * - * @param string|string[] $faxNumber - * - * @return static - * - * @see http://schema.org/faxNumber - */ - public function faxNumber($faxNumber) - { - return $this->setProperty('faxNumber', $faxNumber); - } - - /** - * The hours during which this service or contact is available. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable - * - * @return static - * - * @see http://schema.org/hoursAvailable - */ - public function hoursAvailable($hoursAvailable) - { - return $this->setProperty('hoursAvailable', $hoursAvailable); - } - - /** - * The product or service this support contact point is related to (such as - * product support for a particular product line). This can be a specific - * product or product line (e.g. "iPhone") or a general category of products - * or services (e.g. "smartphones"). - * - * @param Product|Product[]|string|string[] $productSupported - * - * @return static - * - * @see http://schema.org/productSupported - */ - public function productSupported($productSupported) - { - return $this->setProperty('productSupported', $productSupported); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * The telephone number. + * A description of the item. * - * @param string|string[] $telephone + * @param string|string[] $description * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/description */ - public function telephone($telephone) + public function description($description) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('description', $description); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * 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. * - * @param string|string[] $additionalType + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/disambiguatingDescription */ - public function additionalType($additionalType) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * An alias for the item. + * Email address. * - * @param string|string[] $alternateName + * @param string|string[] $email * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/email */ - public function alternateName($alternateName) + public function email($email) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('email', $email); } /** - * A description of the item. + * The fax number. * - * @param string|string[] $description + * @param string|string[] $faxNumber * * @return static * - * @see http://schema.org/description + * @see http://schema.org/faxNumber */ - public function description($description) + public function faxNumber($faxNumber) { - return $this->setProperty('description', $description); + return $this->setProperty('faxNumber', $faxNumber); } /** - * 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. + * The hours during which this service or contact is available. * - * @param string|string[] $disambiguatingDescription + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/hoursAvailable */ - public function disambiguatingDescription($disambiguatingDescription) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** @@ -304,6 +259,23 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The product or service this support contact point is related to (such as + * product support for a particular product line). This can be a specific + * product or product line (e.g. "iPhone") or a general category of products + * or services (e.g. "smartphones"). + * + * @param Product|Product[]|string|string[] $productSupported + * + * @return static + * + * @see http://schema.org/productSupported + */ + public function productSupported($productSupported) + { + return $this->setProperty('productSupported', $productSupported); + } + /** * 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 @@ -320,6 +292,20 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * The geographic area where the service is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * + * @return static + * + * @see http://schema.org/serviceArea + */ + public function serviceArea($serviceArea) + { + return $this->setProperty('serviceArea', $serviceArea); + } + /** * A CreativeWork or Event about this Thing. * @@ -334,6 +320,20 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + /** * URL of the item. * diff --git a/src/Continent.php b/src/Continent.php index c72f03242..3d89234b3 100644 --- a/src/Continent.php +++ b/src/Continent.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Contracts/AMRadioChannelContract.php b/src/Contracts/AMRadioChannelContract.php index bef6c491d..e17a16332 100644 --- a/src/Contracts/AMRadioChannelContract.php +++ b/src/Contracts/AMRadioChannelContract.php @@ -4,36 +4,36 @@ interface AMRadioChannelContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function broadcastChannelId($broadcastChannelId); public function broadcastFrequency($broadcastFrequency); public function broadcastServiceTier($broadcastServiceTier); - public function genre($genre); - - public function inBroadcastLineup($inBroadcastLineup); - - public function providesBroadcastService($providesBroadcastService); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function genre($genre); + public function identifier($identifier); public function image($image); + public function inBroadcastLineup($inBroadcastLineup); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function providesBroadcastService($providesBroadcastService); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/APIReferenceContract.php b/src/Contracts/APIReferenceContract.php index f64a8c04e..3d63995e0 100644 --- a/src/Contracts/APIReferenceContract.php +++ b/src/Contracts/APIReferenceContract.php @@ -4,34 +4,6 @@ interface APIReferenceContract { - public function assembly($assembly); - - public function assemblyVersion($assemblyVersion); - - public function executableLibraryName($executableLibraryName); - - public function programmingModel($programmingModel); - - public function targetPlatform($targetPlatform); - - public function dependencies($dependencies); - - public function proficiencyLevel($proficiencyLevel); - - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -50,10 +22,22 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + + public function assembly($assembly); + + public function assemblyVersion($assemblyVersion); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -92,6 +76,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function dependencies($dependencies); + + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -108,6 +98,8 @@ public function encodings($encodings); public function exampleOfWork($exampleOfWork); + public function executableLibraryName($executableLibraryName); + public function expires($expires); public function fileFormat($fileFormat); @@ -120,6 +112,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -146,16 +142,32 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function proficiencyLevel($proficiencyLevel); + + public function programmingModel($programmingModel); + public function provider($provider); public function publication($publication); @@ -172,6 +184,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -180,8 +194,14 @@ public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + + public function targetPlatform($targetPlatform); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -196,34 +216,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/AboutPageContract.php b/src/Contracts/AboutPageContract.php index 46c44582b..cde58aad1 100644 --- a/src/Contracts/AboutPageContract.php +++ b/src/Contracts/AboutPageContract.php @@ -4,26 +4,6 @@ interface AboutPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/AcceptActionContract.php b/src/Contracts/AcceptActionContract.php index 7f8ddacdf..84c3c2faa 100644 --- a/src/Contracts/AcceptActionContract.php +++ b/src/Contracts/AcceptActionContract.php @@ -6,48 +6,48 @@ interface AcceptActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AccommodationContract.php b/src/Contracts/AccommodationContract.php index c53ca3659..b54e79cad 100644 --- a/src/Contracts/AccommodationContract.php +++ b/src/Contracts/AccommodationContract.php @@ -4,22 +4,16 @@ interface AccommodationContract { - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); - - public function numberOfRooms($numberOfRooms); - - public function permittedUsage($permittedUsage); - - public function petsAllowed($petsAllowed); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -30,18 +24,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -52,54 +56,48 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/AccountingServiceContract.php b/src/Contracts/AccountingServiceContract.php index fa1c9c561..9e49f7e6e 100644 --- a/src/Contracts/AccountingServiceContract.php +++ b/src/Contracts/AccountingServiceContract.php @@ -4,36 +4,48 @@ interface AccountingServiceContract { - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -50,6 +62,8 @@ public function events($events); public function faxNumber($faxNumber); + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function founder($founder); public function founders($founders); @@ -60,14 +74,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -76,8 +102,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -86,98 +122,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AchieveActionContract.php b/src/Contracts/AchieveActionContract.php index 60a41e6f0..4988fe1b2 100644 --- a/src/Contracts/AchieveActionContract.php +++ b/src/Contracts/AchieveActionContract.php @@ -6,48 +6,48 @@ interface AchieveActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ActionAccessSpecificationContract.php b/src/Contracts/ActionAccessSpecificationContract.php index 8604d6396..276e64a18 100644 --- a/src/Contracts/ActionAccessSpecificationContract.php +++ b/src/Contracts/ActionAccessSpecificationContract.php @@ -4,26 +4,24 @@ interface ActionAccessSpecificationContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function availabilityEnds($availabilityEnds); public function availabilityStarts($availabilityStarts); public function category($category); - public function eligibleRegion($eligibleRegion); - - public function expectsAcceptanceOf($expectsAcceptanceOf); - - public function requiresSubscription($requiresSubscription); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function eligibleRegion($eligibleRegion); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); @@ -34,6 +32,8 @@ public function name($name); public function potentialAction($potentialAction); + public function requiresSubscription($requiresSubscription); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/ActionContract.php b/src/Contracts/ActionContract.php index 4caa2a208..c1535e398 100644 --- a/src/Contracts/ActionContract.php +++ b/src/Contracts/ActionContract.php @@ -6,48 +6,48 @@ interface ActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ActivateActionContract.php b/src/Contracts/ActivateActionContract.php index ff2a87057..aa9743e8a 100644 --- a/src/Contracts/ActivateActionContract.php +++ b/src/Contracts/ActivateActionContract.php @@ -6,48 +6,48 @@ interface ActivateActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AddActionContract.php b/src/Contracts/AddActionContract.php index 450b74493..6311b1108 100644 --- a/src/Contracts/AddActionContract.php +++ b/src/Contracts/AddActionContract.php @@ -4,54 +4,54 @@ interface AddActionContract { - public function collection($collection); - - public function targetCollection($targetCollection); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); + public function collection($collection); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function targetCollection($targetCollection); + public function url($url); } diff --git a/src/Contracts/AdministrativeAreaContract.php b/src/Contracts/AdministrativeAreaContract.php index 4b38eb41a..7e4474e5e 100644 --- a/src/Contracts/AdministrativeAreaContract.php +++ b/src/Contracts/AdministrativeAreaContract.php @@ -6,10 +6,14 @@ interface AdministrativeAreaContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/AdultEntertainmentContract.php b/src/Contracts/AdultEntertainmentContract.php index df1621b14..221a84f95 100644 --- a/src/Contracts/AdultEntertainmentContract.php +++ b/src/Contracts/AdultEntertainmentContract.php @@ -4,34 +4,48 @@ interface AdultEntertainmentContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AggregateOfferContract.php b/src/Contracts/AggregateOfferContract.php index cb7da64f2..46638758f 100644 --- a/src/Contracts/AggregateOfferContract.php +++ b/src/Contracts/AggregateOfferContract.php @@ -4,22 +4,18 @@ interface AggregateOfferContract { - public function highPrice($highPrice); - - public function lowPrice($lowPrice); - - public function offerCount($offerCount); - - public function offers($offers); - public function acceptedPaymentMethod($acceptedPaymentMethod); public function addOn($addOn); + public function additionalType($additionalType); + public function advanceBookingRequirement($advanceBookingRequirement); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function availability($availability); @@ -38,6 +34,10 @@ public function category($category); public function deliveryLeadTime($deliveryLeadTime); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function eligibleCustomerType($eligibleCustomerType); public function eligibleDuration($eligibleDuration); @@ -56,6 +56,12 @@ public function gtin14($gtin14); public function gtin8($gtin8); + public function highPrice($highPrice); + + public function identifier($identifier); + + public function image($image); + public function includesObject($includesObject); public function ineligibleRegion($ineligibleRegion); @@ -66,8 +72,20 @@ public function itemCondition($itemCondition); public function itemOffered($itemOffered); + public function lowPrice($lowPrice); + + public function mainEntityOfPage($mainEntityOfPage); + public function mpn($mpn); + public function name($name); + + public function offerCount($offerCount); + + public function offers($offers); + + public function potentialAction($potentialAction); + public function price($price); public function priceCurrency($priceCurrency); @@ -80,40 +98,22 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seller($seller); public function serialNumber($serialNumber); public function sku($sku); + public function subjectOf($subjectOf); + + public function url($url); + public function validFrom($validFrom); public function validThrough($validThrough); public function warranty($warranty); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/AggregateRatingContract.php b/src/Contracts/AggregateRatingContract.php index b1e220703..b0e7f4c9a 100644 --- a/src/Contracts/AggregateRatingContract.php +++ b/src/Contracts/AggregateRatingContract.php @@ -4,26 +4,14 @@ interface AggregateRatingContract { - public function itemReviewed($itemReviewed); - - public function ratingCount($ratingCount); + public function additionalType($additionalType); - public function reviewCount($reviewCount); + public function alternateName($alternateName); public function author($author); public function bestRating($bestRating); - public function ratingValue($ratingValue); - - public function reviewAspect($reviewAspect); - - public function worstRating($worstRating); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -32,16 +20,28 @@ public function identifier($identifier); public function image($image); + public function itemReviewed($itemReviewed); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function ratingCount($ratingCount); + + public function ratingValue($ratingValue); + + public function reviewAspect($reviewAspect); + + public function reviewCount($reviewCount); + public function sameAs($sameAs); public function subjectOf($subjectOf); public function url($url); + public function worstRating($worstRating); + } diff --git a/src/Contracts/AgreeActionContract.php b/src/Contracts/AgreeActionContract.php index f6e35ddb9..90c3a0a72 100644 --- a/src/Contracts/AgreeActionContract.php +++ b/src/Contracts/AgreeActionContract.php @@ -6,48 +6,48 @@ interface AgreeActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AirlineContract.php b/src/Contracts/AirlineContract.php index e7bf3f38a..600568033 100644 --- a/src/Contracts/AirlineContract.php +++ b/src/Contracts/AirlineContract.php @@ -4,20 +4,22 @@ interface AirlineContract { - public function boardingPolicy($boardingPolicy); - - public function iataCode($iataCode); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function boardingPolicy($boardingPolicy); + public function brand($brand); public function contactPoint($contactPoint); @@ -26,6 +28,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,6 +64,12 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function iataCode($iataCode); + + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -68,6 +80,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -78,6 +92,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -86,12 +102,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -102,34 +122,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/AirportContract.php b/src/Contracts/AirportContract.php index 76941d5d4..9d760a92c 100644 --- a/src/Contracts/AirportContract.php +++ b/src/Contracts/AirportContract.php @@ -4,18 +4,16 @@ interface AirportContract { - public function iataCode($iataCode); - - public function icaoCode($icaoCode); - - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -26,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -38,6 +40,14 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function iataCode($iataCode); + + public function icaoCode($icaoCode); + + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -48,54 +58,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/AlignmentObjectContract.php b/src/Contracts/AlignmentObjectContract.php index e0294b9c1..a6c9d759f 100644 --- a/src/Contracts/AlignmentObjectContract.php +++ b/src/Contracts/AlignmentObjectContract.php @@ -4,24 +4,18 @@ interface AlignmentObjectContract { - public function alignmentType($alignmentType); - - public function educationalFramework($educationalFramework); - - public function targetDescription($targetDescription); - - public function targetName($targetName); - - public function targetUrl($targetUrl); - public function additionalType($additionalType); + public function alignmentType($alignmentType); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function educationalFramework($educationalFramework); + public function identifier($identifier); public function image($image); @@ -36,6 +30,12 @@ public function sameAs($sameAs); public function subjectOf($subjectOf); + public function targetDescription($targetDescription); + + public function targetName($targetName); + + public function targetUrl($targetUrl); + public function url($url); } diff --git a/src/Contracts/AllocateActionContract.php b/src/Contracts/AllocateActionContract.php index df3402e52..b3644dade 100644 --- a/src/Contracts/AllocateActionContract.php +++ b/src/Contracts/AllocateActionContract.php @@ -6,48 +6,48 @@ interface AllocateActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AmusementParkContract.php b/src/Contracts/AmusementParkContract.php index 79f4ce8b0..823649d52 100644 --- a/src/Contracts/AmusementParkContract.php +++ b/src/Contracts/AmusementParkContract.php @@ -4,34 +4,48 @@ interface AmusementParkContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AnimalShelterContract.php b/src/Contracts/AnimalShelterContract.php index b0fa228de..82314c111 100644 --- a/src/Contracts/AnimalShelterContract.php +++ b/src/Contracts/AnimalShelterContract.php @@ -4,34 +4,48 @@ interface AnimalShelterContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AnswerContract.php b/src/Contracts/AnswerContract.php index 3b80c4219..c1e97cb43 100644 --- a/src/Contracts/AnswerContract.php +++ b/src/Contracts/AnswerContract.php @@ -4,12 +4,6 @@ interface AnswerContract { - public function downvoteCount($downvoteCount); - - public function parentItem($parentItem); - - public function upvoteCount($upvoteCount); - public function about($about); public function accessMode($accessMode); @@ -28,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -70,8 +68,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function downvoteCount($downvoteCount); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -98,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -124,14 +132,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function parentItem($parentItem); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,6 +166,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -160,6 +178,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -174,34 +194,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function upvoteCount($upvoteCount); + + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ApartmentComplexContract.php b/src/Contracts/ApartmentComplexContract.php index 1f3680320..16f30fef3 100644 --- a/src/Contracts/ApartmentComplexContract.php +++ b/src/Contracts/ApartmentComplexContract.php @@ -6,10 +6,14 @@ interface ApartmentComplexContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ApartmentContract.php b/src/Contracts/ApartmentContract.php index 514e76021..c1159123c 100644 --- a/src/Contracts/ApartmentContract.php +++ b/src/Contracts/ApartmentContract.php @@ -4,26 +4,18 @@ interface ApartmentContract { - public function numberOfRooms($numberOfRooms); - - public function occupancy($occupancy); - - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); - - public function numberOfRooms($numberOfRooms); - - public function permittedUsage($permittedUsage); - - public function petsAllowed($petsAllowed); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function branchCode($branchCode); public function containedIn($containedIn); @@ -32,18 +24,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -54,54 +56,50 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + + public function occupancy($occupancy); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/AppendActionContract.php b/src/Contracts/AppendActionContract.php index b6c7cb872..ecfb14e8e 100644 --- a/src/Contracts/AppendActionContract.php +++ b/src/Contracts/AppendActionContract.php @@ -4,55 +4,55 @@ interface AppendActionContract { - public function toLocation($toLocation); + public function actionStatus($actionStatus); - public function collection($collection); + public function additionalType($additionalType); - public function targetCollection($targetCollection); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function collection($collection); - public function endTime($endTime); + public function description($description); - public function error($error); + public function disambiguatingDescription($disambiguatingDescription); - public function instrument($instrument); + public function endTime($endTime); - public function location($location); + public function error($error); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function result($result); - public function image($image); + public function sameAs($sameAs); - public function mainEntityOfPage($mainEntityOfPage); + public function startTime($startTime); - public function name($name); + public function subjectOf($subjectOf); - public function potentialAction($potentialAction); + public function target($target); - public function sameAs($sameAs); + public function targetCollection($targetCollection); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/ApplyActionContract.php b/src/Contracts/ApplyActionContract.php index c5d878c75..371a1a06b 100644 --- a/src/Contracts/ApplyActionContract.php +++ b/src/Contracts/ApplyActionContract.php @@ -6,48 +6,48 @@ interface ApplyActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AquariumContract.php b/src/Contracts/AquariumContract.php index d32a63c81..3f7946860 100644 --- a/src/Contracts/AquariumContract.php +++ b/src/Contracts/AquariumContract.php @@ -4,14 +4,16 @@ interface AquariumContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ArriveActionContract.php b/src/Contracts/ArriveActionContract.php index ec9911d50..c42f995cb 100644 --- a/src/Contracts/ArriveActionContract.php +++ b/src/Contracts/ArriveActionContract.php @@ -4,54 +4,54 @@ interface ArriveActionContract { - public function fromLocation($fromLocation); - - public function toLocation($toLocation); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function fromLocation($fromLocation); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function toLocation($toLocation); + public function url($url); } diff --git a/src/Contracts/ArtGalleryContract.php b/src/Contracts/ArtGalleryContract.php index 5b0db1b89..dac0e789a 100644 --- a/src/Contracts/ArtGalleryContract.php +++ b/src/Contracts/ArtGalleryContract.php @@ -4,34 +4,48 @@ interface ArtGalleryContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ArticleContract.php b/src/Contracts/ArticleContract.php index d91c900e3..17b8052e3 100644 --- a/src/Contracts/ArticleContract.php +++ b/src/Contracts/ArticleContract.php @@ -4,20 +4,6 @@ interface ArticleContract { - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -36,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -78,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -106,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -132,14 +134,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -158,6 +172,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -166,8 +182,12 @@ public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -182,34 +202,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/AskActionContract.php b/src/Contracts/AskActionContract.php index 17333f999..2468ab357 100644 --- a/src/Contracts/AskActionContract.php +++ b/src/Contracts/AskActionContract.php @@ -4,60 +4,60 @@ interface AskActionContract { - public function question($question); - public function about($about); - public function inLanguage($inLanguage); + public function actionStatus($actionStatus); - public function language($language); + public function additionalType($additionalType); - public function recipient($recipient); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function inLanguage($inLanguage); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function language($language); - public function additionalType($additionalType); + public function location($location); - public function alternateName($alternateName); + public function mainEntityOfPage($mainEntityOfPage); - public function description($description); + public function name($name); - public function disambiguatingDescription($disambiguatingDescription); + public function object($object); - public function identifier($identifier); + public function participant($participant); - public function image($image); + public function potentialAction($potentialAction); - public function mainEntityOfPage($mainEntityOfPage); + public function question($question); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AssessActionContract.php b/src/Contracts/AssessActionContract.php index c6dc3d8ef..04d771897 100644 --- a/src/Contracts/AssessActionContract.php +++ b/src/Contracts/AssessActionContract.php @@ -6,48 +6,48 @@ interface AssessActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AssignActionContract.php b/src/Contracts/AssignActionContract.php index 4d4e9a06f..cac4674ce 100644 --- a/src/Contracts/AssignActionContract.php +++ b/src/Contracts/AssignActionContract.php @@ -6,48 +6,48 @@ interface AssignActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AttorneyContract.php b/src/Contracts/AttorneyContract.php index 72af253dc..54dcccc42 100644 --- a/src/Contracts/AttorneyContract.php +++ b/src/Contracts/AttorneyContract.php @@ -4,34 +4,48 @@ interface AttorneyContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AudienceContract.php b/src/Contracts/AudienceContract.php index 69bdc0662..dae8c690b 100644 --- a/src/Contracts/AudienceContract.php +++ b/src/Contracts/AudienceContract.php @@ -4,18 +4,18 @@ interface AudienceContract { - public function audienceType($audienceType); - - public function geographicArea($geographicArea); - public function additionalType($additionalType); public function alternateName($alternateName); + public function audienceType($audienceType); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function geographicArea($geographicArea); + public function identifier($identifier); public function image($image); diff --git a/src/Contracts/AudioObjectContract.php b/src/Contracts/AudioObjectContract.php index 00daf0905..654f74510 100644 --- a/src/Contracts/AudioObjectContract.php +++ b/src/Contracts/AudioObjectContract.php @@ -4,44 +4,6 @@ interface AudioObjectContract { - public function caption($caption); - - public function transcript($transcript); - - public function associatedArticle($associatedArticle); - - public function bitrate($bitrate); - - public function contentSize($contentSize); - - public function contentUrl($contentUrl); - - public function duration($duration); - - public function embedUrl($embedUrl); - - public function encodesCreativeWork($encodesCreativeWork); - - public function encodingFormat($encodingFormat); - - public function endTime($endTime); - - public function height($height); - - public function playerType($playerType); - - public function productionCompany($productionCompany); - - public function regionsAllowed($regionsAllowed); - - public function requiresSubscription($requiresSubscription); - - public function startTime($startTime); - - public function uploadDate($uploadDate); - - public function width($width); - public function about($about); public function accessMode($accessMode); @@ -60,10 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function associatedArticle($associatedArticle); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -76,6 +44,10 @@ public function award($award); public function awards($awards); + public function bitrate($bitrate); + + public function caption($caption); + public function character($character); public function citation($citation); @@ -88,6 +60,10 @@ public function contentLocation($contentLocation); public function contentRating($contentRating); + public function contentSize($contentSize); + + public function contentUrl($contentUrl); + public function contributor($contributor); public function copyrightHolder($copyrightHolder); @@ -102,18 +78,32 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); public function educationalUse($educationalUse); + public function embedUrl($embedUrl); + + public function encodesCreativeWork($encodesCreativeWork); + public function encoding($encoding); + public function encodingFormat($encodingFormat); + public function encodings($encodings); + public function endTime($endTime); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -128,6 +118,12 @@ public function hasPart($hasPart); public function headline($headline); + public function height($height); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -154,16 +150,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function playerType($playerType); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -174,12 +180,18 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function regionsAllowed($regionsAllowed); + public function releasedEvent($releasedEvent); + public function requiresSubscription($requiresSubscription); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -190,6 +202,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startTime($startTime); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -200,38 +216,22 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function transcript($transcript); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function version($version); - - public function video($video); - - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); + public function uploadDate($uploadDate); - public function name($name); + public function url($url); - public function potentialAction($potentialAction); + public function version($version); - public function sameAs($sameAs); + public function video($video); - public function subjectOf($subjectOf); + public function width($width); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/AuthorizeActionContract.php b/src/Contracts/AuthorizeActionContract.php index 44caa873f..119148026 100644 --- a/src/Contracts/AuthorizeActionContract.php +++ b/src/Contracts/AuthorizeActionContract.php @@ -4,52 +4,52 @@ interface AuthorizeActionContract { - public function recipient($recipient); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function recipient($recipient); + + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/AutoBodyShopContract.php b/src/Contracts/AutoBodyShopContract.php index c638f5e5d..e37ea277f 100644 --- a/src/Contracts/AutoBodyShopContract.php +++ b/src/Contracts/AutoBodyShopContract.php @@ -4,34 +4,48 @@ interface AutoBodyShopContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AutoDealerContract.php b/src/Contracts/AutoDealerContract.php index 332cae981..59045d57f 100644 --- a/src/Contracts/AutoDealerContract.php +++ b/src/Contracts/AutoDealerContract.php @@ -4,34 +4,48 @@ interface AutoDealerContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AutoPartsStoreContract.php b/src/Contracts/AutoPartsStoreContract.php index cdc635384..9310c65b4 100644 --- a/src/Contracts/AutoPartsStoreContract.php +++ b/src/Contracts/AutoPartsStoreContract.php @@ -4,34 +4,48 @@ interface AutoPartsStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AutoRentalContract.php b/src/Contracts/AutoRentalContract.php index e1ade4a3e..cd378f218 100644 --- a/src/Contracts/AutoRentalContract.php +++ b/src/Contracts/AutoRentalContract.php @@ -4,34 +4,48 @@ interface AutoRentalContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AutoRepairContract.php b/src/Contracts/AutoRepairContract.php index 4614fcc2f..6d9a88fda 100644 --- a/src/Contracts/AutoRepairContract.php +++ b/src/Contracts/AutoRepairContract.php @@ -4,34 +4,48 @@ interface AutoRepairContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AutoWashContract.php b/src/Contracts/AutoWashContract.php index 76b06f598..3bfdad152 100644 --- a/src/Contracts/AutoWashContract.php +++ b/src/Contracts/AutoWashContract.php @@ -4,34 +4,48 @@ interface AutoWashContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AutomatedTellerContract.php b/src/Contracts/AutomatedTellerContract.php index c9bee153b..68c6565e9 100644 --- a/src/Contracts/AutomatedTellerContract.php +++ b/src/Contracts/AutomatedTellerContract.php @@ -4,36 +4,48 @@ interface AutomatedTellerContract { - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -50,6 +62,8 @@ public function events($events); public function faxNumber($faxNumber); + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function founder($founder); public function founders($founders); @@ -60,14 +74,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -76,8 +102,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -86,98 +122,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/AutomotiveBusinessContract.php b/src/Contracts/AutomotiveBusinessContract.php index ea7f67c0a..aa233212b 100644 --- a/src/Contracts/AutomotiveBusinessContract.php +++ b/src/Contracts/AutomotiveBusinessContract.php @@ -4,34 +4,48 @@ interface AutomotiveBusinessContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BakeryContract.php b/src/Contracts/BakeryContract.php index 7fc95c227..53422bba0 100644 --- a/src/Contracts/BakeryContract.php +++ b/src/Contracts/BakeryContract.php @@ -6,42 +6,48 @@ interface BakeryContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BankAccountContract.php b/src/Contracts/BankAccountContract.php index efdef8ab4..f2f3c86c8 100644 --- a/src/Contracts/BankAccountContract.php +++ b/src/Contracts/BankAccountContract.php @@ -4,13 +4,13 @@ interface BankAccountContract { - public function annualPercentageRate($annualPercentageRate); + public function additionalType($additionalType); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function aggregateRating($aggregateRating); - public function interestRate($interestRate); + public function alternateName($alternateName); - public function aggregateRating($aggregateRating); + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -26,18 +26,36 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -46,6 +64,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -56,26 +76,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/BankOrCreditUnionContract.php b/src/Contracts/BankOrCreditUnionContract.php index c37b3883b..c306fb0c6 100644 --- a/src/Contracts/BankOrCreditUnionContract.php +++ b/src/Contracts/BankOrCreditUnionContract.php @@ -4,36 +4,48 @@ interface BankOrCreditUnionContract { - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -50,6 +62,8 @@ public function events($events); public function faxNumber($faxNumber); + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function founder($founder); public function founders($founders); @@ -60,14 +74,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -76,8 +102,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -86,98 +122,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BarOrPubContract.php b/src/Contracts/BarOrPubContract.php index 7b9941a06..97fcbe7e1 100644 --- a/src/Contracts/BarOrPubContract.php +++ b/src/Contracts/BarOrPubContract.php @@ -6,42 +6,48 @@ interface BarOrPubContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BarcodeContract.php b/src/Contracts/BarcodeContract.php index bda1cba1b..574917df4 100644 --- a/src/Contracts/BarcodeContract.php +++ b/src/Contracts/BarcodeContract.php @@ -4,48 +4,6 @@ interface BarcodeContract { - public function caption($caption); - - public function exifData($exifData); - - public function representativeOfPage($representativeOfPage); - - public function thumbnail($thumbnail); - - public function associatedArticle($associatedArticle); - - public function bitrate($bitrate); - - public function contentSize($contentSize); - - public function contentUrl($contentUrl); - - public function duration($duration); - - public function embedUrl($embedUrl); - - public function encodesCreativeWork($encodesCreativeWork); - - public function encodingFormat($encodingFormat); - - public function endTime($endTime); - - public function height($height); - - public function playerType($playerType); - - public function productionCompany($productionCompany); - - public function regionsAllowed($regionsAllowed); - - public function requiresSubscription($requiresSubscription); - - public function startTime($startTime); - - public function uploadDate($uploadDate); - - public function width($width); - public function about($about); public function accessMode($accessMode); @@ -64,10 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function associatedArticle($associatedArticle); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -80,6 +44,10 @@ public function award($award); public function awards($awards); + public function bitrate($bitrate); + + public function caption($caption); + public function character($character); public function citation($citation); @@ -92,6 +60,10 @@ public function contentLocation($contentLocation); public function contentRating($contentRating); + public function contentSize($contentSize); + + public function contentUrl($contentUrl); + public function contributor($contributor); public function copyrightHolder($copyrightHolder); @@ -106,20 +78,36 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); public function educationalUse($educationalUse); + public function embedUrl($embedUrl); + + public function encodesCreativeWork($encodesCreativeWork); + public function encoding($encoding); + public function encodingFormat($encodingFormat); + public function encodings($encodings); + public function endTime($endTime); + public function exampleOfWork($exampleOfWork); + public function exifData($exifData); + public function expires($expires); public function fileFormat($fileFormat); @@ -132,6 +120,12 @@ public function hasPart($hasPart); public function headline($headline); + public function height($height); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -158,16 +152,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function playerType($playerType); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -178,12 +182,20 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function regionsAllowed($regionsAllowed); + public function releasedEvent($releasedEvent); + public function representativeOfPage($representativeOfPage); + + public function requiresSubscription($requiresSubscription); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -194,12 +206,18 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startTime($startTime); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); public function text($text); + public function thumbnail($thumbnail); + public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); @@ -208,34 +226,16 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function version($version); - - public function video($video); - - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); + public function uploadDate($uploadDate); - public function name($name); + public function url($url); - public function potentialAction($potentialAction); + public function version($version); - public function sameAs($sameAs); + public function video($video); - public function subjectOf($subjectOf); + public function width($width); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/BeachContract.php b/src/Contracts/BeachContract.php index 75c95db59..7d93bee54 100644 --- a/src/Contracts/BeachContract.php +++ b/src/Contracts/BeachContract.php @@ -4,14 +4,16 @@ interface BeachContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/BeautySalonContract.php b/src/Contracts/BeautySalonContract.php index 9554321c2..be3421e9a 100644 --- a/src/Contracts/BeautySalonContract.php +++ b/src/Contracts/BeautySalonContract.php @@ -4,34 +4,48 @@ interface BeautySalonContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BedAndBreakfastContract.php b/src/Contracts/BedAndBreakfastContract.php index 45a36bbc8..6e4227af3 100644 --- a/src/Contracts/BedAndBreakfastContract.php +++ b/src/Contracts/BedAndBreakfastContract.php @@ -4,50 +4,56 @@ interface BedAndBreakfastContract { - public function amenityFeature($amenityFeature); + public function additionalProperty($additionalProperty); - public function audience($audience); + public function additionalType($additionalType); - public function availableLanguage($availableLanguage); + public function address($address); - public function checkinTime($checkinTime); + public function aggregateRating($aggregateRating); - public function checkoutTime($checkoutTime); + public function alternateName($alternateName); - public function numberOfRooms($numberOfRooms); + public function amenityFeature($amenityFeature); - public function petsAllowed($petsAllowed); + public function areaServed($areaServed); - public function starRating($starRating); + public function audience($audience); - public function branchOf($branchOf); + public function availableLanguage($availableLanguage); - public function currenciesAccepted($currenciesAccepted); + public function award($award); - public function openingHours($openingHours); + public function awards($awards); - public function paymentAccepted($paymentAccepted); + public function branchCode($branchCode); - public function priceRange($priceRange); + public function branchOf($branchOf); - public function address($address); + public function brand($brand); - public function aggregateRating($aggregateRating); + public function checkinTime($checkinTime); - public function areaServed($areaServed); + public function checkoutTime($checkoutTime); - public function award($award); + public function contactPoint($contactPoint); - public function awards($awards); + public function contactPoints($contactPoints); - public function brand($brand); + public function containedIn($containedIn); - public function contactPoint($contactPoint); + public function containedInPlace($containedInPlace); - public function contactPoints($contactPoints); + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -74,14 +80,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -90,106 +108,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); + public function longitude($longitude); - public function owns($owns); + public function mainEntityOfPage($mainEntityOfPage); - public function parentOrganization($parentOrganization); + public function makesOffer($makesOffer); - public function publishingPrinciples($publishingPrinciples); + public function map($map); - public function review($review); + public function maps($maps); - public function reviews($reviews); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function seeks($seeks); + public function member($member); - public function serviceArea($serviceArea); + public function memberOf($memberOf); - public function slogan($slogan); + public function members($members); - public function sponsor($sponsor); + public function naics($naics); - public function subOrganization($subOrganization); + public function name($name); - public function taxID($taxID); + public function numberOfEmployees($numberOfEmployees); - public function telephone($telephone); + public function numberOfRooms($numberOfRooms); - public function vatID($vatID); + public function offeredBy($offeredBy); - public function additionalType($additionalType); + public function openingHours($openingHours); - public function alternateName($alternateName); + public function openingHoursSpecification($openingHoursSpecification); - public function description($description); + public function owns($owns); - public function disambiguatingDescription($disambiguatingDescription); + public function parentOrganization($parentOrganization); - public function identifier($identifier); + public function paymentAccepted($paymentAccepted); - public function image($image); + public function petsAllowed($petsAllowed); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function branchCode($branchCode); + public function publicAccess($publicAccess); - public function containedIn($containedIn); + public function publishingPrinciples($publishingPrinciples); - public function containedInPlace($containedInPlace); + public function review($review); - public function containsPlace($containsPlace); + public function reviews($reviews); - public function geo($geo); + public function sameAs($sameAs); - public function hasMap($hasMap); + public function seeks($seeks); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BedDetailsContract.php b/src/Contracts/BedDetailsContract.php index 646eaa67a..cbbbddfe9 100644 --- a/src/Contracts/BedDetailsContract.php +++ b/src/Contracts/BedDetailsContract.php @@ -4,10 +4,6 @@ interface BedDetailsContract { - public function numberOfBeds($numberOfBeds); - - public function typeOfBed($typeOfBed); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -24,12 +20,16 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function numberOfBeds($numberOfBeds); + public function potentialAction($potentialAction); public function sameAs($sameAs); public function subjectOf($subjectOf); + public function typeOfBed($typeOfBed); + public function url($url); } diff --git a/src/Contracts/BedTypeContract.php b/src/Contracts/BedTypeContract.php index e0ec813f1..c8d96cf4a 100644 --- a/src/Contracts/BedTypeContract.php +++ b/src/Contracts/BedTypeContract.php @@ -6,20 +6,6 @@ interface BedTypeContract { public function additionalProperty($additionalProperty); - public function equal($equal); - - public function greater($greater); - - public function greaterOrEqual($greaterOrEqual); - - public function lesser($lesser); - - public function lesserOrEqual($lesserOrEqual); - - public function nonEqual($nonEqual); - - public function valueReference($valueReference); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -28,14 +14,26 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function equal($equal); + + public function greater($greater); + + public function greaterOrEqual($greaterOrEqual); + public function identifier($identifier); public function image($image); + public function lesser($lesser); + + public function lesserOrEqual($lesserOrEqual); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function nonEqual($nonEqual); + public function potentialAction($potentialAction); public function sameAs($sameAs); @@ -44,4 +42,6 @@ public function subjectOf($subjectOf); public function url($url); + public function valueReference($valueReference); + } diff --git a/src/Contracts/BefriendActionContract.php b/src/Contracts/BefriendActionContract.php index 16d2d4bd3..8a3661ebe 100644 --- a/src/Contracts/BefriendActionContract.php +++ b/src/Contracts/BefriendActionContract.php @@ -6,48 +6,48 @@ interface BefriendActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/BikeStoreContract.php b/src/Contracts/BikeStoreContract.php index a72d2a89b..b715b34d2 100644 --- a/src/Contracts/BikeStoreContract.php +++ b/src/Contracts/BikeStoreContract.php @@ -4,34 +4,48 @@ interface BikeStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BlogContract.php b/src/Contracts/BlogContract.php index cb6484a25..4fd44dfd8 100644 --- a/src/Contracts/BlogContract.php +++ b/src/Contracts/BlogContract.php @@ -4,12 +4,6 @@ interface BlogContract { - public function blogPost($blogPost); - - public function blogPosts($blogPosts); - - public function issn($issn); - public function about($about); public function accessMode($accessMode); @@ -28,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -44,6 +42,10 @@ public function award($award); public function awards($awards); + public function blogPost($blogPost); + + public function blogPosts($blogPosts); + public function character($character); public function citation($citation); @@ -70,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -98,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -114,6 +124,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -124,14 +136,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -160,6 +180,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -174,34 +196,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/BlogPostingContract.php b/src/Contracts/BlogPostingContract.php index 1b93abfde..9e7d70ebf 100644 --- a/src/Contracts/BlogPostingContract.php +++ b/src/Contracts/BlogPostingContract.php @@ -4,22 +4,6 @@ interface BlogPostingContract { - public function sharedContent($sharedContent); - - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -38,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -80,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -108,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -134,14 +134,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -160,16 +172,24 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function sharedContent($sharedContent); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -184,34 +204,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/BodyOfWaterContract.php b/src/Contracts/BodyOfWaterContract.php index 1ead57afc..3115823c0 100644 --- a/src/Contracts/BodyOfWaterContract.php +++ b/src/Contracts/BodyOfWaterContract.php @@ -6,10 +6,14 @@ interface BodyOfWaterContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/BookContract.php b/src/Contracts/BookContract.php index 5f95b2c4f..2a2577109 100644 --- a/src/Contracts/BookContract.php +++ b/src/Contracts/BookContract.php @@ -4,16 +4,6 @@ interface BookContract { - public function bookEdition($bookEdition); - - public function bookFormat($bookFormat); - - public function illustrator($illustrator); - - public function isbn($isbn); - - public function numberOfPages($numberOfPages); - public function about($about); public function accessMode($accessMode); @@ -32,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -48,6 +42,10 @@ public function award($award); public function awards($awards); + public function bookEdition($bookEdition); + + public function bookFormat($bookFormat); + public function character($character); public function citation($citation); @@ -74,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -102,6 +104,12 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function illustrator($illustrator); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,6 +126,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function isbn($isbn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -128,14 +138,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function numberOfPages($numberOfPages); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -154,6 +172,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -164,6 +184,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -178,34 +200,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/BookSeriesContract.php b/src/Contracts/BookSeriesContract.php index 8669a5025..3dd0622f2 100644 --- a/src/Contracts/BookSeriesContract.php +++ b/src/Contracts/BookSeriesContract.php @@ -4,12 +4,6 @@ interface BookSeriesContract { - public function endDate($endDate); - - public function issn($issn); - - public function startDate($startDate); - public function about($about); public function accessMode($accessMode); @@ -28,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -70,6 +68,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -84,6 +88,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -98,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -114,6 +124,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -124,14 +136,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -160,6 +180,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -174,36 +198,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function director($director); - } diff --git a/src/Contracts/BookStoreContract.php b/src/Contracts/BookStoreContract.php index 3c3e30ad1..ad2923016 100644 --- a/src/Contracts/BookStoreContract.php +++ b/src/Contracts/BookStoreContract.php @@ -4,34 +4,48 @@ interface BookStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BookmarkActionContract.php b/src/Contracts/BookmarkActionContract.php index 69a8f0c26..a9f85f619 100644 --- a/src/Contracts/BookmarkActionContract.php +++ b/src/Contracts/BookmarkActionContract.php @@ -6,48 +6,48 @@ interface BookmarkActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/BorrowActionContract.php b/src/Contracts/BorrowActionContract.php index 4d0811a7e..e6ba8b6ff 100644 --- a/src/Contracts/BorrowActionContract.php +++ b/src/Contracts/BorrowActionContract.php @@ -4,55 +4,55 @@ interface BorrowActionContract { - public function lender($lender); + public function actionStatus($actionStatus); - public function fromLocation($fromLocation); + public function additionalType($additionalType); - public function toLocation($toLocation); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); + public function fromLocation($fromLocation); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function lender($lender); - public function target($target); + public function location($location); - public function additionalType($additionalType); + public function mainEntityOfPage($mainEntityOfPage); - public function alternateName($alternateName); + public function name($name); - public function description($description); + public function object($object); - public function disambiguatingDescription($disambiguatingDescription); + public function participant($participant); - public function identifier($identifier); + public function potentialAction($potentialAction); - public function image($image); + public function result($result); - public function mainEntityOfPage($mainEntityOfPage); + public function sameAs($sameAs); - public function name($name); + public function startTime($startTime); - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function target($target); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/BowlingAlleyContract.php b/src/Contracts/BowlingAlleyContract.php index 941889524..eac63017f 100644 --- a/src/Contracts/BowlingAlleyContract.php +++ b/src/Contracts/BowlingAlleyContract.php @@ -4,34 +4,48 @@ interface BowlingAlleyContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BrandContract.php b/src/Contracts/BrandContract.php index 741a12d0c..3f602373c 100644 --- a/src/Contracts/BrandContract.php +++ b/src/Contracts/BrandContract.php @@ -4,16 +4,10 @@ interface BrandContract { - public function aggregateRating($aggregateRating); - - public function logo($logo); - - public function review($review); - - public function slogan($slogan); - public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); public function description($description); @@ -24,14 +18,20 @@ public function identifier($identifier); public function image($image); + public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function review($review); + public function sameAs($sameAs); + public function slogan($slogan); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/BreadcrumbListContract.php b/src/Contracts/BreadcrumbListContract.php index 5be2aca4f..fb28f4c1f 100644 --- a/src/Contracts/BreadcrumbListContract.php +++ b/src/Contracts/BreadcrumbListContract.php @@ -4,12 +4,6 @@ interface BreadcrumbListContract { - public function itemListElement($itemListElement); - - public function itemListOrder($itemListOrder); - - public function numberOfItems($numberOfItems); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -22,10 +16,16 @@ public function identifier($identifier); public function image($image); + public function itemListElement($itemListElement); + + public function itemListOrder($itemListOrder); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function numberOfItems($numberOfItems); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/BreweryContract.php b/src/Contracts/BreweryContract.php index e432eb20b..16d01d7d6 100644 --- a/src/Contracts/BreweryContract.php +++ b/src/Contracts/BreweryContract.php @@ -6,42 +6,48 @@ interface BreweryContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/BridgeContract.php b/src/Contracts/BridgeContract.php index 1e19fe998..2abdb96c9 100644 --- a/src/Contracts/BridgeContract.php +++ b/src/Contracts/BridgeContract.php @@ -4,14 +4,16 @@ interface BridgeContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/BroadcastChannelContract.php b/src/Contracts/BroadcastChannelContract.php index a53490f22..647aa05bc 100644 --- a/src/Contracts/BroadcastChannelContract.php +++ b/src/Contracts/BroadcastChannelContract.php @@ -4,36 +4,36 @@ interface BroadcastChannelContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function broadcastChannelId($broadcastChannelId); public function broadcastFrequency($broadcastFrequency); public function broadcastServiceTier($broadcastServiceTier); - public function genre($genre); - - public function inBroadcastLineup($inBroadcastLineup); - - public function providesBroadcastService($providesBroadcastService); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function genre($genre); + public function identifier($identifier); public function image($image); + public function inBroadcastLineup($inBroadcastLineup); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function providesBroadcastService($providesBroadcastService); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/BroadcastEventContract.php b/src/Contracts/BroadcastEventContract.php index dc55a1986..c13129428 100644 --- a/src/Contracts/BroadcastEventContract.php +++ b/src/Contracts/BroadcastEventContract.php @@ -4,36 +4,34 @@ interface BroadcastEventContract { - public function broadcastOfEvent($broadcastOfEvent); - - public function isLiveBroadcast($isLiveBroadcast); - - public function videoFormat($videoFormat); - - public function free($free); - - public function isAccessibleForFree($isAccessibleForFree); - - public function publishedOn($publishedOn); - public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); public function audience($audience); + public function broadcastOfEvent($broadcastOfEvent); + public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -42,14 +40,28 @@ public function endDate($endDate); public function eventStatus($eventStatus); + public function free($free); + public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function isAccessibleForFree($isAccessibleForFree); + + public function isLiveBroadcast($isLiveBroadcast); + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -58,14 +70,20 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); + public function publishedOn($publishedOn); + public function recordedIn($recordedIn); public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -74,38 +92,20 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function workFeatured($workFeatured); - - public function workPerformed($workPerformed); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); + public function url($url); - public function sameAs($sameAs); + public function videoFormat($videoFormat); - public function subjectOf($subjectOf); + public function workFeatured($workFeatured); - public function url($url); + public function workPerformed($workPerformed); } diff --git a/src/Contracts/BroadcastFrequencySpecificationContract.php b/src/Contracts/BroadcastFrequencySpecificationContract.php index 6bb640f0a..d7d23d2de 100644 --- a/src/Contracts/BroadcastFrequencySpecificationContract.php +++ b/src/Contracts/BroadcastFrequencySpecificationContract.php @@ -4,12 +4,12 @@ interface BroadcastFrequencySpecificationContract { - public function broadcastFrequencyValue($broadcastFrequencyValue); - public function additionalType($additionalType); public function alternateName($alternateName); + public function broadcastFrequencyValue($broadcastFrequencyValue); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); diff --git a/src/Contracts/BroadcastServiceContract.php b/src/Contracts/BroadcastServiceContract.php index 8b477c251..db610bfd4 100644 --- a/src/Contracts/BroadcastServiceContract.php +++ b/src/Contracts/BroadcastServiceContract.php @@ -4,25 +4,13 @@ interface BroadcastServiceContract { - public function area($area); - - public function broadcastAffiliateOf($broadcastAffiliateOf); - - public function broadcastDisplayName($broadcastDisplayName); - - public function broadcastFrequency($broadcastFrequency); - - public function broadcastTimezone($broadcastTimezone); - - public function broadcaster($broadcaster); - - public function hasBroadcastChannel($hasBroadcastChannel); + public function additionalType($additionalType); - public function parentService($parentService); + public function aggregateRating($aggregateRating); - public function videoFormat($videoFormat); + public function alternateName($alternateName); - public function aggregateRating($aggregateRating); + public function area($area); public function areaServed($areaServed); @@ -34,22 +22,50 @@ public function award($award); public function brand($brand); + public function broadcastAffiliateOf($broadcastAffiliateOf); + + public function broadcastDisplayName($broadcastDisplayName); + + public function broadcastFrequency($broadcastFrequency); + + public function broadcastTimezone($broadcastTimezone); + + public function broadcaster($broadcaster); + public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function hasBroadcastChannel($hasBroadcastChannel); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function parentService($parentService); + + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -58,6 +74,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -68,28 +86,10 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); + public function videoFormat($videoFormat); + } diff --git a/src/Contracts/BuddhistTempleContract.php b/src/Contracts/BuddhistTempleContract.php index 9b4c1d922..9b431280e 100644 --- a/src/Contracts/BuddhistTempleContract.php +++ b/src/Contracts/BuddhistTempleContract.php @@ -4,14 +4,16 @@ interface BuddhistTempleContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/BusReservationContract.php b/src/Contracts/BusReservationContract.php index 122add76c..12dc338b2 100644 --- a/src/Contracts/BusReservationContract.php +++ b/src/Contracts/BusReservationContract.php @@ -4,14 +4,32 @@ interface BusReservationContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function bookingAgent($bookingAgent); public function bookingTime($bookingTime); public function broker($broker); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function identifier($identifier); + + public function image($image); + + public function mainEntityOfPage($mainEntityOfPage); + public function modifiedTime($modifiedTime); + public function name($name); + + public function potentialAction($potentialAction); + public function priceCurrency($priceCurrency); public function programMembershipUsed($programMembershipUsed); @@ -26,32 +44,14 @@ public function reservationStatus($reservationStatus); public function reservedTicket($reservedTicket); - public function totalPrice($totalPrice); - - public function underName($underName); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - public function sameAs($sameAs); public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/BusStationContract.php b/src/Contracts/BusStationContract.php index a7d1b6e6e..31fe78abf 100644 --- a/src/Contracts/BusStationContract.php +++ b/src/Contracts/BusStationContract.php @@ -4,14 +4,16 @@ interface BusStationContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/BusStopContract.php b/src/Contracts/BusStopContract.php index 7b8ecd7c0..6d4f3992d 100644 --- a/src/Contracts/BusStopContract.php +++ b/src/Contracts/BusStopContract.php @@ -4,14 +4,16 @@ interface BusStopContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/BusTripContract.php b/src/Contracts/BusTripContract.php index dd5eea6f8..3c8c54f06 100644 --- a/src/Contracts/BusTripContract.php +++ b/src/Contracts/BusTripContract.php @@ -4,26 +4,22 @@ interface BusTripContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function arrivalBusStop($arrivalBusStop); + public function arrivalTime($arrivalTime); + public function busName($busName); public function busNumber($busNumber); public function departureBusStop($departureBusStop); - public function arrivalTime($arrivalTime); - public function departureTime($departureTime); - public function offers($offers); - - public function provider($provider); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -36,8 +32,12 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function provider($provider); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/BusinessAudienceContract.php b/src/Contracts/BusinessAudienceContract.php index 0e75a264a..1a81ed4e8 100644 --- a/src/Contracts/BusinessAudienceContract.php +++ b/src/Contracts/BusinessAudienceContract.php @@ -4,24 +4,18 @@ interface BusinessAudienceContract { - public function numberOfEmployees($numberOfEmployees); - - public function yearlyRevenue($yearlyRevenue); - - public function yearsInOperation($yearsInOperation); - - public function audienceType($audienceType); - - public function geographicArea($geographicArea); - public function additionalType($additionalType); public function alternateName($alternateName); + public function audienceType($audienceType); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function geographicArea($geographicArea); + public function identifier($identifier); public function image($image); @@ -30,6 +24,8 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function numberOfEmployees($numberOfEmployees); + public function potentialAction($potentialAction); public function sameAs($sameAs); @@ -38,4 +34,8 @@ public function subjectOf($subjectOf); public function url($url); + public function yearlyRevenue($yearlyRevenue); + + public function yearsInOperation($yearsInOperation); + } diff --git a/src/Contracts/BusinessEventContract.php b/src/Contracts/BusinessEventContract.php index 4d45163dd..f2b48ab54 100644 --- a/src/Contracts/BusinessEventContract.php +++ b/src/Contracts/BusinessEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/BuyActionContract.php b/src/Contracts/BuyActionContract.php index b14495aa6..a8d84a459 100644 --- a/src/Contracts/BuyActionContract.php +++ b/src/Contracts/BuyActionContract.php @@ -4,62 +4,62 @@ interface BuyActionContract { - public function seller($seller); - - public function vendor($vendor); - - public function warrantyPromise($warrantyPromise); + public function actionStatus($actionStatus); - public function price($price); + public function additionalType($additionalType); - public function priceCurrency($priceCurrency); + public function agent($agent); - public function priceSpecification($priceSpecification); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function description($description); - public function agent($agent); + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); + public function identifier($identifier); + + public function image($image); + public function instrument($instrument); public function location($location); - public function object($object); + public function mainEntityOfPage($mainEntityOfPage); - public function participant($participant); + public function name($name); - public function result($result); + public function object($object); - public function startTime($startTime); + public function participant($participant); - public function target($target); + public function potentialAction($potentialAction); - public function additionalType($additionalType); + public function price($price); - public function alternateName($alternateName); + public function priceCurrency($priceCurrency); - public function description($description); + public function priceSpecification($priceSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function result($result); - public function identifier($identifier); + public function sameAs($sameAs); - public function image($image); + public function seller($seller); - public function mainEntityOfPage($mainEntityOfPage); + public function startTime($startTime); - public function name($name); + public function subjectOf($subjectOf); - public function potentialAction($potentialAction); + public function target($target); - public function sameAs($sameAs); + public function url($url); - public function subjectOf($subjectOf); + public function vendor($vendor); - public function url($url); + public function warrantyPromise($warrantyPromise); } diff --git a/src/Contracts/CableOrSatelliteServiceContract.php b/src/Contracts/CableOrSatelliteServiceContract.php index d7d290cf0..c6aafa430 100644 --- a/src/Contracts/CableOrSatelliteServiceContract.php +++ b/src/Contracts/CableOrSatelliteServiceContract.php @@ -4,8 +4,12 @@ interface CableOrSatelliteServiceContract { + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function audience($audience); @@ -20,18 +24,32 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -40,6 +58,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -50,26 +70,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/CafeOrCoffeeShopContract.php b/src/Contracts/CafeOrCoffeeShopContract.php index d7219953c..60d802d5f 100644 --- a/src/Contracts/CafeOrCoffeeShopContract.php +++ b/src/Contracts/CafeOrCoffeeShopContract.php @@ -6,42 +6,48 @@ interface CafeOrCoffeeShopContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/CampgroundContract.php b/src/Contracts/CampgroundContract.php index 4c3875ff6..44c6fe338 100644 --- a/src/Contracts/CampgroundContract.php +++ b/src/Contracts/CampgroundContract.php @@ -4,191 +4,191 @@ interface CampgroundContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); - public function amenityFeature($amenityFeature); + public function alternateName($alternateName); - public function branchCode($branchCode); + public function amenityFeature($amenityFeature); - public function containedIn($containedIn); + public function areaServed($areaServed); - public function containedInPlace($containedInPlace); + public function audience($audience); - public function containsPlace($containsPlace); + public function availableLanguage($availableLanguage); - public function event($event); + public function award($award); - public function events($events); + public function awards($awards); - public function faxNumber($faxNumber); + public function branchCode($branchCode); - public function geo($geo); + public function branchOf($branchOf); - public function globalLocationNumber($globalLocationNumber); + public function brand($brand); - public function hasMap($hasMap); + public function checkinTime($checkinTime); - public function isAccessibleForFree($isAccessibleForFree); + public function checkoutTime($checkoutTime); - public function isicV4($isicV4); + public function contactPoint($contactPoint); - public function latitude($latitude); + public function contactPoints($contactPoints); - public function logo($logo); + public function containedIn($containedIn); - public function longitude($longitude); + public function containedInPlace($containedInPlace); - public function map($map); + public function containsPlace($containsPlace); - public function maps($maps); + public function currenciesAccepted($currenciesAccepted); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function department($department); - public function openingHoursSpecification($openingHoursSpecification); + public function description($description); - public function photo($photo); + public function disambiguatingDescription($disambiguatingDescription); - public function photos($photos); + public function dissolutionDate($dissolutionDate); - public function publicAccess($publicAccess); + public function duns($duns); - public function review($review); + public function email($email); - public function reviews($reviews); + public function employee($employee); - public function slogan($slogan); + public function employees($employees); - public function smokingAllowed($smokingAllowed); + public function event($event); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function events($events); - public function telephone($telephone); + public function faxNumber($faxNumber); - public function additionalType($additionalType); + public function founder($founder); - public function alternateName($alternateName); + public function founders($founders); - public function description($description); + public function foundingDate($foundingDate); - public function disambiguatingDescription($disambiguatingDescription); + public function foundingLocation($foundingLocation); - public function identifier($identifier); + public function funder($funder); - public function image($image); + public function geo($geo); - public function mainEntityOfPage($mainEntityOfPage); + public function globalLocationNumber($globalLocationNumber); - public function name($name); + public function hasMap($hasMap); - public function potentialAction($potentialAction); + public function hasOfferCatalog($hasOfferCatalog); - public function sameAs($sameAs); + public function hasPOS($hasPOS); - public function subjectOf($subjectOf); + public function identifier($identifier); - public function url($url); + public function image($image); - public function audience($audience); + public function isAccessibleForFree($isAccessibleForFree); - public function availableLanguage($availableLanguage); + public function isicV4($isicV4); - public function checkinTime($checkinTime); + public function latitude($latitude); - public function checkoutTime($checkoutTime); + public function legalName($legalName); - public function numberOfRooms($numberOfRooms); + public function leiCode($leiCode); - public function petsAllowed($petsAllowed); + public function location($location); - public function starRating($starRating); + public function logo($logo); - public function branchOf($branchOf); + public function longitude($longitude); - public function currenciesAccepted($currenciesAccepted); + public function mainEntityOfPage($mainEntityOfPage); - public function paymentAccepted($paymentAccepted); + public function makesOffer($makesOffer); - public function priceRange($priceRange); + public function map($map); - public function areaServed($areaServed); + public function maps($maps); - public function award($award); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function awards($awards); + public function member($member); - public function brand($brand); + public function memberOf($memberOf); - public function contactPoint($contactPoint); + public function members($members); - public function contactPoints($contactPoints); + public function naics($naics); - public function department($department); + public function name($name); - public function dissolutionDate($dissolutionDate); + public function numberOfEmployees($numberOfEmployees); - public function duns($duns); + public function numberOfRooms($numberOfRooms); - public function email($email); + public function offeredBy($offeredBy); - public function employee($employee); + public function openingHours($openingHours); - public function employees($employees); + public function openingHoursSpecification($openingHoursSpecification); - public function founder($founder); + public function owns($owns); - public function founders($founders); + public function parentOrganization($parentOrganization); - public function foundingDate($foundingDate); + public function paymentAccepted($paymentAccepted); - public function foundingLocation($foundingLocation); + public function petsAllowed($petsAllowed); - public function funder($funder); + public function photo($photo); - public function hasOfferCatalog($hasOfferCatalog); + public function photos($photos); - public function hasPOS($hasPOS); + public function potentialAction($potentialAction); - public function legalName($legalName); + public function priceRange($priceRange); - public function leiCode($leiCode); + public function publicAccess($publicAccess); - public function location($location); + public function publishingPrinciples($publishingPrinciples); - public function makesOffer($makesOffer); + public function review($review); - public function member($member); + public function reviews($reviews); - public function memberOf($memberOf); + public function sameAs($sameAs); - public function members($members); + public function seeks($seeks); - public function naics($naics); + public function serviceArea($serviceArea); - public function numberOfEmployees($numberOfEmployees); + public function slogan($slogan); - public function offeredBy($offeredBy); + public function smokingAllowed($smokingAllowed); - public function owns($owns); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function parentOrganization($parentOrganization); + public function sponsor($sponsor); - public function publishingPrinciples($publishingPrinciples); + public function starRating($starRating); - public function seeks($seeks); + public function subOrganization($subOrganization); - public function serviceArea($serviceArea); + public function subjectOf($subjectOf); - public function sponsor($sponsor); + public function taxID($taxID); - public function subOrganization($subOrganization); + public function telephone($telephone); - public function taxID($taxID); + public function url($url); public function vatID($vatID); diff --git a/src/Contracts/CampingPitchContract.php b/src/Contracts/CampingPitchContract.php index 66d8ddf84..a90b5ce81 100644 --- a/src/Contracts/CampingPitchContract.php +++ b/src/Contracts/CampingPitchContract.php @@ -4,22 +4,18 @@ interface CampingPitchContract { - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); - - public function numberOfRooms($numberOfRooms); - - public function permittedUsage($permittedUsage); - - public function petsAllowed($petsAllowed); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function branchCode($branchCode); public function containedIn($containedIn); @@ -28,18 +24,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -50,54 +56,48 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CanalContract.php b/src/Contracts/CanalContract.php index 8c38c73c0..87b563dab 100644 --- a/src/Contracts/CanalContract.php +++ b/src/Contracts/CanalContract.php @@ -6,10 +6,14 @@ interface CanalContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CancelActionContract.php b/src/Contracts/CancelActionContract.php index bd03a65c2..6c743c6f8 100644 --- a/src/Contracts/CancelActionContract.php +++ b/src/Contracts/CancelActionContract.php @@ -4,52 +4,52 @@ interface CancelActionContract { - public function scheduledTime($scheduledTime); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function scheduledTime($scheduledTime); + + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/CarContract.php b/src/Contracts/CarContract.php index 885c5db15..16330c486 100644 --- a/src/Contracts/CarContract.php +++ b/src/Contracts/CarContract.php @@ -4,73 +4,43 @@ interface CarContract { - public function cargoVolume($cargoVolume); - - public function dateVehicleFirstRegistered($dateVehicleFirstRegistered); - - public function driveWheelConfiguration($driveWheelConfiguration); - - public function fuelConsumption($fuelConsumption); - - public function fuelEfficiency($fuelEfficiency); - - public function fuelType($fuelType); - - public function knownVehicleDamages($knownVehicleDamages); - - public function mileageFromOdometer($mileageFromOdometer); - - public function numberOfAirbags($numberOfAirbags); - - public function numberOfAxles($numberOfAxles); - - public function numberOfDoors($numberOfDoors); - - public function numberOfForwardGears($numberOfForwardGears); - - public function numberOfPreviousOwners($numberOfPreviousOwners); - - public function productionDate($productionDate); - - public function purchaseDate($purchaseDate); - - public function steeringPosition($steeringPosition); + public function additionalProperty($additionalProperty); - public function vehicleConfiguration($vehicleConfiguration); + public function additionalType($additionalType); - public function vehicleEngine($vehicleEngine); + public function aggregateRating($aggregateRating); - public function vehicleIdentificationNumber($vehicleIdentificationNumber); + public function alternateName($alternateName); - public function vehicleInteriorColor($vehicleInteriorColor); + public function audience($audience); - public function vehicleInteriorType($vehicleInteriorType); + public function award($award); - public function vehicleModelDate($vehicleModelDate); + public function awards($awards); - public function vehicleSeatingCapacity($vehicleSeatingCapacity); + public function brand($brand); - public function vehicleSpecialUsage($vehicleSpecialUsage); + public function cargoVolume($cargoVolume); - public function vehicleTransmission($vehicleTransmission); + public function category($category); - public function additionalProperty($additionalProperty); + public function color($color); - public function aggregateRating($aggregateRating); + public function dateVehicleFirstRegistered($dateVehicleFirstRegistered); - public function audience($audience); + public function depth($depth); - public function award($award); + public function description($description); - public function awards($awards); + public function disambiguatingDescription($disambiguatingDescription); - public function brand($brand); + public function driveWheelConfiguration($driveWheelConfiguration); - public function category($category); + public function fuelConsumption($fuelConsumption); - public function color($color); + public function fuelEfficiency($fuelEfficiency); - public function depth($depth); + public function fuelType($fuelType); public function gtin12($gtin12); @@ -82,6 +52,10 @@ public function gtin8($gtin8); public function height($height); + public function identifier($identifier); + + public function image($image); + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor); public function isConsumableFor($isConsumableFor); @@ -92,56 +66,82 @@ public function isSimilarTo($isSimilarTo); public function itemCondition($itemCondition); + public function knownVehicleDamages($knownVehicleDamages); + public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function manufacturer($manufacturer); public function material($material); + public function mileageFromOdometer($mileageFromOdometer); + public function model($model); public function mpn($mpn); + public function name($name); + + public function numberOfAirbags($numberOfAirbags); + + public function numberOfAxles($numberOfAxles); + + public function numberOfDoors($numberOfDoors); + + public function numberOfForwardGears($numberOfForwardGears); + + public function numberOfPreviousOwners($numberOfPreviousOwners); + public function offers($offers); + public function potentialAction($potentialAction); + public function productID($productID); + public function productionDate($productionDate); + + public function purchaseDate($purchaseDate); + public function releaseDate($releaseDate); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function sku($sku); public function slogan($slogan); - public function weight($weight); + public function steeringPosition($steeringPosition); - public function width($width); + public function subjectOf($subjectOf); - public function additionalType($additionalType); + public function url($url); - public function alternateName($alternateName); + public function vehicleConfiguration($vehicleConfiguration); - public function description($description); + public function vehicleEngine($vehicleEngine); - public function disambiguatingDescription($disambiguatingDescription); + public function vehicleIdentificationNumber($vehicleIdentificationNumber); - public function identifier($identifier); + public function vehicleInteriorColor($vehicleInteriorColor); - public function image($image); + public function vehicleInteriorType($vehicleInteriorType); - public function mainEntityOfPage($mainEntityOfPage); + public function vehicleModelDate($vehicleModelDate); - public function name($name); + public function vehicleSeatingCapacity($vehicleSeatingCapacity); - public function potentialAction($potentialAction); + public function vehicleSpecialUsage($vehicleSpecialUsage); - public function sameAs($sameAs); + public function vehicleTransmission($vehicleTransmission); - public function subjectOf($subjectOf); + public function weight($weight); - public function url($url); + public function width($width); } diff --git a/src/Contracts/CasinoContract.php b/src/Contracts/CasinoContract.php index b4e5c2a52..1d8edc4d7 100644 --- a/src/Contracts/CasinoContract.php +++ b/src/Contracts/CasinoContract.php @@ -4,34 +4,48 @@ interface CasinoContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/CatholicChurchContract.php b/src/Contracts/CatholicChurchContract.php index 1b72f5f7b..1ebfc93a2 100644 --- a/src/Contracts/CatholicChurchContract.php +++ b/src/Contracts/CatholicChurchContract.php @@ -4,14 +4,16 @@ interface CatholicChurchContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CemeteryContract.php b/src/Contracts/CemeteryContract.php index c9ba297ee..d11b57d0d 100644 --- a/src/Contracts/CemeteryContract.php +++ b/src/Contracts/CemeteryContract.php @@ -4,14 +4,16 @@ interface CemeteryContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CheckActionContract.php b/src/Contracts/CheckActionContract.php index d0288fd10..0ce38a35b 100644 --- a/src/Contracts/CheckActionContract.php +++ b/src/Contracts/CheckActionContract.php @@ -6,48 +6,48 @@ interface CheckActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/CheckInActionContract.php b/src/Contracts/CheckInActionContract.php index bc51a5953..1dd381eef 100644 --- a/src/Contracts/CheckInActionContract.php +++ b/src/Contracts/CheckInActionContract.php @@ -6,56 +6,56 @@ interface CheckInActionContract { public function about($about); - public function inLanguage($inLanguage); - - public function language($language); - - public function recipient($recipient); - public function actionStatus($actionStatus); + public function additionalType($additionalType); + public function agent($agent); - public function endTime($endTime); + public function alternateName($alternateName); - public function error($error); + public function description($description); - public function instrument($instrument); + public function disambiguatingDescription($disambiguatingDescription); - public function location($location); + public function endTime($endTime); - public function object($object); + public function error($error); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function inLanguage($inLanguage); - public function target($target); + public function instrument($instrument); - public function additionalType($additionalType); + public function language($language); - public function alternateName($alternateName); + public function location($location); - public function description($description); + public function mainEntityOfPage($mainEntityOfPage); - public function disambiguatingDescription($disambiguatingDescription); + public function name($name); - public function identifier($identifier); + public function object($object); - public function image($image); + public function participant($participant); - public function mainEntityOfPage($mainEntityOfPage); + public function potentialAction($potentialAction); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/CheckOutActionContract.php b/src/Contracts/CheckOutActionContract.php index 9eb14e1d9..a13c7bf9c 100644 --- a/src/Contracts/CheckOutActionContract.php +++ b/src/Contracts/CheckOutActionContract.php @@ -6,56 +6,56 @@ interface CheckOutActionContract { public function about($about); - public function inLanguage($inLanguage); - - public function language($language); - - public function recipient($recipient); - public function actionStatus($actionStatus); + public function additionalType($additionalType); + public function agent($agent); - public function endTime($endTime); + public function alternateName($alternateName); - public function error($error); + public function description($description); - public function instrument($instrument); + public function disambiguatingDescription($disambiguatingDescription); - public function location($location); + public function endTime($endTime); - public function object($object); + public function error($error); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function inLanguage($inLanguage); - public function target($target); + public function instrument($instrument); - public function additionalType($additionalType); + public function language($language); - public function alternateName($alternateName); + public function location($location); - public function description($description); + public function mainEntityOfPage($mainEntityOfPage); - public function disambiguatingDescription($disambiguatingDescription); + public function name($name); - public function identifier($identifier); + public function object($object); - public function image($image); + public function participant($participant); - public function mainEntityOfPage($mainEntityOfPage); + public function potentialAction($potentialAction); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/CheckoutPageContract.php b/src/Contracts/CheckoutPageContract.php index 508975c6c..2584dac8a 100644 --- a/src/Contracts/CheckoutPageContract.php +++ b/src/Contracts/CheckoutPageContract.php @@ -4,26 +4,6 @@ interface CheckoutPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ChildCareContract.php b/src/Contracts/ChildCareContract.php index 398d75756..efcda80e6 100644 --- a/src/Contracts/ChildCareContract.php +++ b/src/Contracts/ChildCareContract.php @@ -4,34 +4,48 @@ interface ChildCareContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ChildrensEventContract.php b/src/Contracts/ChildrensEventContract.php index 3f9925380..1f1b9f77e 100644 --- a/src/Contracts/ChildrensEventContract.php +++ b/src/Contracts/ChildrensEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ChooseActionContract.php b/src/Contracts/ChooseActionContract.php index c4c3bf4ac..8d2e1f041 100644 --- a/src/Contracts/ChooseActionContract.php +++ b/src/Contracts/ChooseActionContract.php @@ -6,52 +6,52 @@ interface ChooseActionContract { public function actionOption($actionOption); - public function option($option); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function option($option); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ChurchContract.php b/src/Contracts/ChurchContract.php index 89f081b34..edbd2e055 100644 --- a/src/Contracts/ChurchContract.php +++ b/src/Contracts/ChurchContract.php @@ -4,14 +4,16 @@ interface ChurchContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CityContract.php b/src/Contracts/CityContract.php index a27907933..1cb7f2c18 100644 --- a/src/Contracts/CityContract.php +++ b/src/Contracts/CityContract.php @@ -6,10 +6,14 @@ interface CityContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CityHallContract.php b/src/Contracts/CityHallContract.php index 70adb1aff..1d832b555 100644 --- a/src/Contracts/CityHallContract.php +++ b/src/Contracts/CityHallContract.php @@ -4,14 +4,16 @@ interface CityHallContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CivicStructureContract.php b/src/Contracts/CivicStructureContract.php index 98b09d86e..5b2c82dfb 100644 --- a/src/Contracts/CivicStructureContract.php +++ b/src/Contracts/CivicStructureContract.php @@ -4,14 +4,16 @@ interface CivicStructureContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ClaimReviewContract.php b/src/Contracts/ClaimReviewContract.php index f0dbc0ad8..4c3ed689c 100644 --- a/src/Contracts/ClaimReviewContract.php +++ b/src/Contracts/ClaimReviewContract.php @@ -4,16 +4,6 @@ interface ClaimReviewContract { - public function claimReviewed($claimReviewed); - - public function itemReviewed($itemReviewed); - - public function reviewAspect($reviewAspect); - - public function reviewBody($reviewBody); - - public function reviewRating($reviewRating); - public function about($about); public function accessMode($accessMode); @@ -32,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -52,6 +46,8 @@ public function character($character); public function citation($citation); + public function claimReviewed($claimReviewed); + public function comment($comment); public function commentCount($commentCount); @@ -74,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -102,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,6 +122,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function itemReviewed($itemReviewed); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -128,14 +134,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -152,8 +164,16 @@ public function releasedEvent($releasedEvent); public function review($review); + public function reviewAspect($reviewAspect); + + public function reviewBody($reviewBody); + + public function reviewRating($reviewRating); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -164,6 +184,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -178,34 +200,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ClipContract.php b/src/Contracts/ClipContract.php index 435f2e5ea..0e485c4c9 100644 --- a/src/Contracts/ClipContract.php +++ b/src/Contracts/ClipContract.php @@ -4,24 +4,6 @@ interface ClipContract { - public function actor($actor); - - public function actors($actors); - - public function clipNumber($clipNumber); - - public function director($director); - - public function directors($directors); - - public function musicBy($musicBy); - - public function partOfEpisode($partOfEpisode); - - public function partOfSeason($partOfSeason); - - public function partOfSeries($partOfSeries); - public function about($about); public function accessMode($accessMode); @@ -40,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -60,6 +50,8 @@ public function character($character); public function citation($citation); + public function clipNumber($clipNumber); + public function comment($comment); public function commentCount($commentCount); @@ -82,6 +74,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -110,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,14 +140,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function partOfEpisode($partOfEpisode); + + public function partOfSeason($partOfSeason); + + public function partOfSeries($partOfSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -162,6 +180,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -172,6 +192,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -186,34 +208,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ClothingStoreContract.php b/src/Contracts/ClothingStoreContract.php index de4254ee9..999ad21ba 100644 --- a/src/Contracts/ClothingStoreContract.php +++ b/src/Contracts/ClothingStoreContract.php @@ -4,34 +4,48 @@ interface ClothingStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/CodeContract.php b/src/Contracts/CodeContract.php index 469c6e2cd..9605607b8 100644 --- a/src/Contracts/CodeContract.php +++ b/src/Contracts/CodeContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CollectionPageContract.php b/src/Contracts/CollectionPageContract.php index 98bae44d1..112385a37 100644 --- a/src/Contracts/CollectionPageContract.php +++ b/src/Contracts/CollectionPageContract.php @@ -4,26 +4,6 @@ interface CollectionPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CollegeOrUniversityContract.php b/src/Contracts/CollegeOrUniversityContract.php index 4e190dd86..9c8a596a4 100644 --- a/src/Contracts/CollegeOrUniversityContract.php +++ b/src/Contracts/CollegeOrUniversityContract.php @@ -4,12 +4,16 @@ interface CollegeOrUniversityContract { - public function alumni($alumni); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function alumni($alumni); + public function areaServed($areaServed); public function award($award); @@ -24,6 +28,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +64,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +78,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +90,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +100,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -100,34 +120,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/ComedyClubContract.php b/src/Contracts/ComedyClubContract.php index 904bb4067..bd153745a 100644 --- a/src/Contracts/ComedyClubContract.php +++ b/src/Contracts/ComedyClubContract.php @@ -4,34 +4,48 @@ interface ComedyClubContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ComedyEventContract.php b/src/Contracts/ComedyEventContract.php index 167011d68..cc37ad2fb 100644 --- a/src/Contracts/ComedyEventContract.php +++ b/src/Contracts/ComedyEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CommentActionContract.php b/src/Contracts/CommentActionContract.php index ef8cecb22..8a4924f42 100644 --- a/src/Contracts/CommentActionContract.php +++ b/src/Contracts/CommentActionContract.php @@ -4,60 +4,60 @@ interface CommentActionContract { - public function resultComment($resultComment); - public function about($about); - public function inLanguage($inLanguage); + public function actionStatus($actionStatus); - public function language($language); + public function additionalType($additionalType); - public function recipient($recipient); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function inLanguage($inLanguage); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function language($language); - public function additionalType($additionalType); + public function location($location); - public function alternateName($alternateName); + public function mainEntityOfPage($mainEntityOfPage); - public function description($description); + public function name($name); - public function disambiguatingDescription($disambiguatingDescription); + public function object($object); - public function identifier($identifier); + public function participant($participant); - public function image($image); + public function potentialAction($potentialAction); - public function mainEntityOfPage($mainEntityOfPage); + public function recipient($recipient); - public function name($name); + public function result($result); - public function potentialAction($potentialAction); + public function resultComment($resultComment); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/CommentContract.php b/src/Contracts/CommentContract.php index 388f4cf7b..47453d8e5 100644 --- a/src/Contracts/CommentContract.php +++ b/src/Contracts/CommentContract.php @@ -4,12 +4,6 @@ interface CommentContract { - public function downvoteCount($downvoteCount); - - public function parentItem($parentItem); - - public function upvoteCount($upvoteCount); - public function about($about); public function accessMode($accessMode); @@ -28,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -70,8 +68,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function downvoteCount($downvoteCount); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -98,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -124,14 +132,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function parentItem($parentItem); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,6 +166,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -160,6 +178,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -174,34 +194,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function upvoteCount($upvoteCount); + + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CommunicateActionContract.php b/src/Contracts/CommunicateActionContract.php index 144be110f..af5905d63 100644 --- a/src/Contracts/CommunicateActionContract.php +++ b/src/Contracts/CommunicateActionContract.php @@ -6,56 +6,56 @@ interface CommunicateActionContract { public function about($about); - public function inLanguage($inLanguage); - - public function language($language); - - public function recipient($recipient); - public function actionStatus($actionStatus); + public function additionalType($additionalType); + public function agent($agent); - public function endTime($endTime); + public function alternateName($alternateName); - public function error($error); + public function description($description); - public function instrument($instrument); + public function disambiguatingDescription($disambiguatingDescription); - public function location($location); + public function endTime($endTime); - public function object($object); + public function error($error); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function inLanguage($inLanguage); - public function target($target); + public function instrument($instrument); - public function additionalType($additionalType); + public function language($language); - public function alternateName($alternateName); + public function location($location); - public function description($description); + public function mainEntityOfPage($mainEntityOfPage); - public function disambiguatingDescription($disambiguatingDescription); + public function name($name); - public function identifier($identifier); + public function object($object); - public function image($image); + public function participant($participant); - public function mainEntityOfPage($mainEntityOfPage); + public function potentialAction($potentialAction); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/CompoundPriceSpecificationContract.php b/src/Contracts/CompoundPriceSpecificationContract.php index bf3892497..4baa63810 100644 --- a/src/Contracts/CompoundPriceSpecificationContract.php +++ b/src/Contracts/CompoundPriceSpecificationContract.php @@ -4,26 +4,6 @@ interface CompoundPriceSpecificationContract { - public function priceComponent($priceComponent); - - public function eligibleQuantity($eligibleQuantity); - - public function eligibleTransactionVolume($eligibleTransactionVolume); - - public function maxPrice($maxPrice); - - public function minPrice($minPrice); - - public function price($price); - - public function priceCurrency($priceCurrency); - - public function validFrom($validFrom); - - public function validThrough($validThrough); - - public function valueAddedTaxIncluded($valueAddedTaxIncluded); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -32,20 +12,40 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function eligibleQuantity($eligibleQuantity); + + public function eligibleTransactionVolume($eligibleTransactionVolume); + public function identifier($identifier); public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function maxPrice($maxPrice); + + public function minPrice($minPrice); + public function name($name); public function potentialAction($potentialAction); + public function price($price); + + public function priceComponent($priceComponent); + + public function priceCurrency($priceCurrency); + public function sameAs($sameAs); public function subjectOf($subjectOf); public function url($url); + public function validFrom($validFrom); + + public function validThrough($validThrough); + + public function valueAddedTaxIncluded($valueAddedTaxIncluded); + } diff --git a/src/Contracts/ComputerStoreContract.php b/src/Contracts/ComputerStoreContract.php index 624f5cb0c..2b3a49d81 100644 --- a/src/Contracts/ComputerStoreContract.php +++ b/src/Contracts/ComputerStoreContract.php @@ -4,34 +4,48 @@ interface ComputerStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ConfirmActionContract.php b/src/Contracts/ConfirmActionContract.php index 8ef0bc22d..7f55fdb62 100644 --- a/src/Contracts/ConfirmActionContract.php +++ b/src/Contracts/ConfirmActionContract.php @@ -4,60 +4,60 @@ interface ConfirmActionContract { - public function event($event); - public function about($about); - public function inLanguage($inLanguage); + public function actionStatus($actionStatus); - public function language($language); + public function additionalType($additionalType); - public function recipient($recipient); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function event($event); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function inLanguage($inLanguage); - public function target($target); + public function instrument($instrument); - public function additionalType($additionalType); + public function language($language); - public function alternateName($alternateName); + public function location($location); - public function description($description); + public function mainEntityOfPage($mainEntityOfPage); - public function disambiguatingDescription($disambiguatingDescription); + public function name($name); - public function identifier($identifier); + public function object($object); - public function image($image); + public function participant($participant); - public function mainEntityOfPage($mainEntityOfPage); + public function potentialAction($potentialAction); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ConsumeActionContract.php b/src/Contracts/ConsumeActionContract.php index 984e02638..809cd8de9 100644 --- a/src/Contracts/ConsumeActionContract.php +++ b/src/Contracts/ConsumeActionContract.php @@ -6,52 +6,52 @@ interface ConsumeActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ContactPageContract.php b/src/Contracts/ContactPageContract.php index 93b44a3bb..cf93b36c0 100644 --- a/src/Contracts/ContactPageContract.php +++ b/src/Contracts/ContactPageContract.php @@ -4,26 +4,6 @@ interface ContactPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ContactPointContract.php b/src/Contracts/ContactPointContract.php index 6304876b8..f262535e3 100644 --- a/src/Contracts/ContactPointContract.php +++ b/src/Contracts/ContactPointContract.php @@ -4,6 +4,10 @@ interface ContactPointContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function areaServed($areaServed); public function availableLanguage($availableLanguage); @@ -12,26 +16,16 @@ public function contactOption($contactOption); public function contactType($contactType); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function email($email); public function faxNumber($faxNumber); public function hoursAvailable($hoursAvailable); - public function productSupported($productSupported); - - public function serviceArea($serviceArea); - - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - public function identifier($identifier); public function image($image); @@ -42,10 +36,16 @@ public function name($name); public function potentialAction($potentialAction); + public function productSupported($productSupported); + public function sameAs($sameAs); + public function serviceArea($serviceArea); + public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ContinentContract.php b/src/Contracts/ContinentContract.php index 9b721ea61..296a99c76 100644 --- a/src/Contracts/ContinentContract.php +++ b/src/Contracts/ContinentContract.php @@ -6,10 +6,14 @@ interface ContinentContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ControlActionContract.php b/src/Contracts/ControlActionContract.php index 9837ba379..fd93b423b 100644 --- a/src/Contracts/ControlActionContract.php +++ b/src/Contracts/ControlActionContract.php @@ -6,48 +6,48 @@ interface ControlActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ConvenienceStoreContract.php b/src/Contracts/ConvenienceStoreContract.php index c355e66ad..9caa135d2 100644 --- a/src/Contracts/ConvenienceStoreContract.php +++ b/src/Contracts/ConvenienceStoreContract.php @@ -4,34 +4,48 @@ interface ConvenienceStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ConversationContract.php b/src/Contracts/ConversationContract.php index 83300f021..bc26fe1ab 100644 --- a/src/Contracts/ConversationContract.php +++ b/src/Contracts/ConversationContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CookActionContract.php b/src/Contracts/CookActionContract.php index 79b79e5d0..e5a3af9b8 100644 --- a/src/Contracts/CookActionContract.php +++ b/src/Contracts/CookActionContract.php @@ -4,56 +4,56 @@ interface CookActionContract { - public function foodEstablishment($foodEstablishment); - - public function foodEvent($foodEvent); - - public function recipe($recipe); - public function actionStatus($actionStatus); + public function additionalType($additionalType); + public function agent($agent); - public function endTime($endTime); + public function alternateName($alternateName); - public function error($error); + public function description($description); - public function instrument($instrument); + public function disambiguatingDescription($disambiguatingDescription); - public function location($location); + public function endTime($endTime); - public function object($object); + public function error($error); - public function participant($participant); + public function foodEstablishment($foodEstablishment); - public function result($result); + public function foodEvent($foodEvent); - public function startTime($startTime); + public function identifier($identifier); - public function target($target); + public function image($image); - public function additionalType($additionalType); + public function instrument($instrument); - public function alternateName($alternateName); + public function location($location); - public function description($description); + public function mainEntityOfPage($mainEntityOfPage); - public function disambiguatingDescription($disambiguatingDescription); + public function name($name); - public function identifier($identifier); + public function object($object); - public function image($image); + public function participant($participant); - public function mainEntityOfPage($mainEntityOfPage); + public function potentialAction($potentialAction); - public function name($name); + public function recipe($recipe); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/CorporationContract.php b/src/Contracts/CorporationContract.php index e47666d5f..663608ae6 100644 --- a/src/Contracts/CorporationContract.php +++ b/src/Contracts/CorporationContract.php @@ -4,12 +4,14 @@ interface CorporationContract { - public function tickerSymbol($tickerSymbol); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -24,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -100,34 +118,16 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function tickerSymbol($tickerSymbol); public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/CountryContract.php b/src/Contracts/CountryContract.php index 26dde7696..f910b24cc 100644 --- a/src/Contracts/CountryContract.php +++ b/src/Contracts/CountryContract.php @@ -6,10 +6,14 @@ interface CountryContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CourseContract.php b/src/Contracts/CourseContract.php index 5d9a32b2b..654b68713 100644 --- a/src/Contracts/CourseContract.php +++ b/src/Contracts/CourseContract.php @@ -4,12 +4,6 @@ interface CourseContract { - public function courseCode($courseCode); - - public function coursePrerequisites($coursePrerequisites); - - public function hasCourseInstance($hasCourseInstance); - public function about($about); public function accessMode($accessMode); @@ -28,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -62,6 +60,10 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function courseCode($courseCode); + + public function coursePrerequisites($coursePrerequisites); + public function creator($creator); public function dateCreated($dateCreated); @@ -70,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -94,10 +100,16 @@ public function funder($funder); public function genre($genre); + public function hasCourseInstance($hasCourseInstance); + public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -124,14 +136,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -160,6 +180,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -174,34 +196,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CourseInstanceContract.php b/src/Contracts/CourseInstanceContract.php index 07af35b50..b8619f50a 100644 --- a/src/Contracts/CourseInstanceContract.php +++ b/src/Contracts/CourseInstanceContract.php @@ -4,16 +4,16 @@ interface CourseInstanceContract { - public function courseMode($courseMode); - - public function instructor($instructor); - public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -24,8 +24,14 @@ public function composer($composer); public function contributor($contributor); + public function courseMode($courseMode); + + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -36,14 +42,24 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function instructor($instructor); + public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -52,6 +68,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -60,6 +78,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -68,38 +88,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CourthouseContract.php b/src/Contracts/CourthouseContract.php index ae9dd432d..0281677b7 100644 --- a/src/Contracts/CourthouseContract.php +++ b/src/Contracts/CourthouseContract.php @@ -4,14 +4,16 @@ interface CourthouseContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CreateActionContract.php b/src/Contracts/CreateActionContract.php index dd73ef13b..19e6f1c0e 100644 --- a/src/Contracts/CreateActionContract.php +++ b/src/Contracts/CreateActionContract.php @@ -6,48 +6,48 @@ interface CreateActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/CreativeWorkContract.php b/src/Contracts/CreativeWorkContract.php index 64f5f1429..07bd90154 100644 --- a/src/Contracts/CreativeWorkContract.php +++ b/src/Contracts/CreativeWorkContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CreativeWorkSeasonContract.php b/src/Contracts/CreativeWorkSeasonContract.php index 0a74dc64d..01f6e01a9 100644 --- a/src/Contracts/CreativeWorkSeasonContract.php +++ b/src/Contracts/CreativeWorkSeasonContract.php @@ -4,28 +4,6 @@ interface CreativeWorkSeasonContract { - public function actor($actor); - - public function director($director); - - public function endDate($endDate); - - public function episode($episode); - - public function episodes($episodes); - - public function numberOfEpisodes($numberOfEpisodes); - - public function partOfSeries($partOfSeries); - - public function productionCompany($productionCompany); - - public function seasonNumber($seasonNumber); - - public function startDate($startDate); - - public function trailer($trailer); - public function about($about); public function accessMode($accessMode); @@ -44,8 +22,14 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -86,6 +70,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -100,6 +90,12 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + + public function episode($episode); + + public function episodes($episodes); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -114,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -140,16 +140,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function numberOfEpisodes($numberOfEpisodes); + public function offers($offers); + public function partOfSeries($partOfSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -166,8 +178,12 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function seasonNumber($seasonNumber); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -176,6 +192,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -186,38 +206,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/CreativeWorkSeriesContract.php b/src/Contracts/CreativeWorkSeriesContract.php index a514b9ab4..7b2e1568a 100644 --- a/src/Contracts/CreativeWorkSeriesContract.php +++ b/src/Contracts/CreativeWorkSeriesContract.php @@ -4,12 +4,6 @@ interface CreativeWorkSeriesContract { - public function endDate($endDate); - - public function issn($issn); - - public function startDate($startDate); - public function about($about); public function accessMode($accessMode); @@ -28,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -70,6 +68,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -84,6 +88,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -98,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -114,6 +124,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -124,14 +136,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -160,6 +180,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -174,36 +198,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function director($director); - } diff --git a/src/Contracts/CreditCardContract.php b/src/Contracts/CreditCardContract.php index ca43ef292..d68c2ff7a 100644 --- a/src/Contracts/CreditCardContract.php +++ b/src/Contracts/CreditCardContract.php @@ -4,13 +4,15 @@ interface CreditCardContract { - public function annualPercentageRate($annualPercentageRate); + public function additionalType($additionalType); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function aggregateRating($aggregateRating); - public function interestRate($interestRate); + public function alternateName($alternateName); - public function aggregateRating($aggregateRating); + public function amount($amount); + + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -26,26 +28,50 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); + public function loanTerm($loanTerm); + public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); public function providerMobility($providerMobility); + public function requiredCollateral($requiredCollateral); + public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -56,34 +82,8 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); - public function amount($amount); - - public function loanTerm($loanTerm); - - public function requiredCollateral($requiredCollateral); - } diff --git a/src/Contracts/CrematoriumContract.php b/src/Contracts/CrematoriumContract.php index 4ab0e608f..3b91834d6 100644 --- a/src/Contracts/CrematoriumContract.php +++ b/src/Contracts/CrematoriumContract.php @@ -4,14 +4,16 @@ interface CrematoriumContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/CurrencyConversionServiceContract.php b/src/Contracts/CurrencyConversionServiceContract.php index d7313c5f4..fa7c3d23d 100644 --- a/src/Contracts/CurrencyConversionServiceContract.php +++ b/src/Contracts/CurrencyConversionServiceContract.php @@ -4,13 +4,13 @@ interface CurrencyConversionServiceContract { - public function annualPercentageRate($annualPercentageRate); + public function additionalType($additionalType); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function aggregateRating($aggregateRating); - public function interestRate($interestRate); + public function alternateName($alternateName); - public function aggregateRating($aggregateRating); + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -26,18 +26,36 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -46,6 +64,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -56,26 +76,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/DanceEventContract.php b/src/Contracts/DanceEventContract.php index 8a4fc34a5..a3325045e 100644 --- a/src/Contracts/DanceEventContract.php +++ b/src/Contracts/DanceEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/DanceGroupContract.php b/src/Contracts/DanceGroupContract.php index 5f0a9fa74..9a03dfb79 100644 --- a/src/Contracts/DanceGroupContract.php +++ b/src/Contracts/DanceGroupContract.php @@ -4,10 +4,14 @@ interface DanceGroupContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/DataCatalogContract.php b/src/Contracts/DataCatalogContract.php index 4ccc363e7..3119b85be 100644 --- a/src/Contracts/DataCatalogContract.php +++ b/src/Contracts/DataCatalogContract.php @@ -4,8 +4,6 @@ interface DataCatalogContract { - public function dataset($dataset); - public function about($about); public function accessMode($accessMode); @@ -24,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -60,12 +62,18 @@ public function copyrightYear($copyrightYear); public function creator($creator); + public function dataset($dataset); + public function dateCreated($dateCreated); public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -94,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -120,14 +132,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -156,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,34 +192,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/DataDownloadContract.php b/src/Contracts/DataDownloadContract.php index 3266aeca8..bd57fa240 100644 --- a/src/Contracts/DataDownloadContract.php +++ b/src/Contracts/DataDownloadContract.php @@ -4,40 +4,6 @@ interface DataDownloadContract { - public function associatedArticle($associatedArticle); - - public function bitrate($bitrate); - - public function contentSize($contentSize); - - public function contentUrl($contentUrl); - - public function duration($duration); - - public function embedUrl($embedUrl); - - public function encodesCreativeWork($encodesCreativeWork); - - public function encodingFormat($encodingFormat); - - public function endTime($endTime); - - public function height($height); - - public function playerType($playerType); - - public function productionCompany($productionCompany); - - public function regionsAllowed($regionsAllowed); - - public function requiresSubscription($requiresSubscription); - - public function startTime($startTime); - - public function uploadDate($uploadDate); - - public function width($width); - public function about($about); public function accessMode($accessMode); @@ -56,10 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function associatedArticle($associatedArticle); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -72,6 +44,8 @@ public function award($award); public function awards($awards); + public function bitrate($bitrate); + public function character($character); public function citation($citation); @@ -84,6 +58,10 @@ public function contentLocation($contentLocation); public function contentRating($contentRating); + public function contentSize($contentSize); + + public function contentUrl($contentUrl); + public function contributor($contributor); public function copyrightHolder($copyrightHolder); @@ -98,18 +76,32 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); public function educationalUse($educationalUse); + public function embedUrl($embedUrl); + + public function encodesCreativeWork($encodesCreativeWork); + public function encoding($encoding); + public function encodingFormat($encodingFormat); + public function encodings($encodings); + public function endTime($endTime); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -124,6 +116,12 @@ public function hasPart($hasPart); public function headline($headline); + public function height($height); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -150,16 +148,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function playerType($playerType); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -170,12 +178,18 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function regionsAllowed($regionsAllowed); + public function releasedEvent($releasedEvent); + public function requiresSubscription($requiresSubscription); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -186,6 +200,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startTime($startTime); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -200,34 +218,16 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function version($version); - - public function video($video); - - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); + public function uploadDate($uploadDate); - public function name($name); + public function url($url); - public function potentialAction($potentialAction); + public function version($version); - public function sameAs($sameAs); + public function video($video); - public function subjectOf($subjectOf); + public function width($width); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/DataFeedContract.php b/src/Contracts/DataFeedContract.php index 71d498df5..2c2061a2d 100644 --- a/src/Contracts/DataFeedContract.php +++ b/src/Contracts/DataFeedContract.php @@ -4,20 +4,6 @@ interface DataFeedContract { - public function dataFeedElement($dataFeedElement); - - public function catalog($catalog); - - public function datasetTimeInterval($datasetTimeInterval); - - public function distribution($distribution); - - public function includedDataCatalog($includedDataCatalog); - - public function includedInDataCatalog($includedInDataCatalog); - - public function issn($issn); - public function about($about); public function accessMode($accessMode); @@ -36,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -52,6 +42,8 @@ public function award($award); public function awards($awards); + public function catalog($catalog); + public function character($character); public function citation($citation); @@ -72,14 +64,24 @@ public function copyrightYear($copyrightYear); public function creator($creator); + public function dataFeedElement($dataFeedElement); + + public function datasetTimeInterval($datasetTimeInterval); + public function dateCreated($dateCreated); public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function distribution($distribution); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -106,8 +108,16 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function includedDataCatalog($includedDataCatalog); + + public function includedInDataCatalog($includedInDataCatalog); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -122,6 +132,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -132,14 +144,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -158,6 +176,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -168,6 +188,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -182,34 +204,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/DataFeedItemContract.php b/src/Contracts/DataFeedItemContract.php index 4524b1ac1..555d2a611 100644 --- a/src/Contracts/DataFeedItemContract.php +++ b/src/Contracts/DataFeedItemContract.php @@ -4,18 +4,16 @@ interface DataFeedItemContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function dateCreated($dateCreated); public function dateDeleted($dateDeleted); public function dateModified($dateModified); - public function item($item); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -24,6 +22,8 @@ public function identifier($identifier); public function image($image); + public function item($item); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); diff --git a/src/Contracts/DatasetContract.php b/src/Contracts/DatasetContract.php index 6b3e0f7e8..a5d5b74f9 100644 --- a/src/Contracts/DatasetContract.php +++ b/src/Contracts/DatasetContract.php @@ -4,18 +4,6 @@ interface DatasetContract { - public function catalog($catalog); - - public function datasetTimeInterval($datasetTimeInterval); - - public function distribution($distribution); - - public function includedDataCatalog($includedDataCatalog); - - public function includedInDataCatalog($includedInDataCatalog); - - public function issn($issn); - public function about($about); public function accessMode($accessMode); @@ -34,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -50,6 +42,8 @@ public function award($award); public function awards($awards); + public function catalog($catalog); + public function character($character); public function citation($citation); @@ -70,14 +64,22 @@ public function copyrightYear($copyrightYear); public function creator($creator); + public function datasetTimeInterval($datasetTimeInterval); + public function dateCreated($dateCreated); public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function distribution($distribution); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -104,8 +106,16 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function includedDataCatalog($includedDataCatalog); + + public function includedInDataCatalog($includedInDataCatalog); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -120,6 +130,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -130,14 +142,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -156,6 +174,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -166,6 +186,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -180,34 +202,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/DatedMoneySpecificationContract.php b/src/Contracts/DatedMoneySpecificationContract.php index d0184b9aa..2783245c3 100644 --- a/src/Contracts/DatedMoneySpecificationContract.php +++ b/src/Contracts/DatedMoneySpecificationContract.php @@ -4,14 +4,14 @@ interface DatedMoneySpecificationContract { - public function amount($amount); - - public function currency($currency); - public function additionalType($additionalType); public function alternateName($alternateName); + public function amount($amount); + + public function currency($currency); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); diff --git a/src/Contracts/DaySpaContract.php b/src/Contracts/DaySpaContract.php index a77e6c4e7..0cb64cbdd 100644 --- a/src/Contracts/DaySpaContract.php +++ b/src/Contracts/DaySpaContract.php @@ -4,34 +4,48 @@ interface DaySpaContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/DeactivateActionContract.php b/src/Contracts/DeactivateActionContract.php index 91fba1797..b97155a23 100644 --- a/src/Contracts/DeactivateActionContract.php +++ b/src/Contracts/DeactivateActionContract.php @@ -6,48 +6,48 @@ interface DeactivateActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/DefenceEstablishmentContract.php b/src/Contracts/DefenceEstablishmentContract.php index f67a35e23..0437781d3 100644 --- a/src/Contracts/DefenceEstablishmentContract.php +++ b/src/Contracts/DefenceEstablishmentContract.php @@ -4,14 +4,16 @@ interface DefenceEstablishmentContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/DeleteActionContract.php b/src/Contracts/DeleteActionContract.php index c7bb767a4..c8f0fc639 100644 --- a/src/Contracts/DeleteActionContract.php +++ b/src/Contracts/DeleteActionContract.php @@ -4,54 +4,54 @@ interface DeleteActionContract { - public function collection($collection); - - public function targetCollection($targetCollection); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); + public function collection($collection); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function targetCollection($targetCollection); + public function url($url); } diff --git a/src/Contracts/DeliveryChargeSpecificationContract.php b/src/Contracts/DeliveryChargeSpecificationContract.php index 36a4c166d..4d829b5b5 100644 --- a/src/Contracts/DeliveryChargeSpecificationContract.php +++ b/src/Contracts/DeliveryChargeSpecificationContract.php @@ -4,54 +4,54 @@ interface DeliveryChargeSpecificationContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function appliesToDeliveryMethod($appliesToDeliveryMethod); public function areaServed($areaServed); - public function eligibleRegion($eligibleRegion); + public function description($description); - public function ineligibleRegion($ineligibleRegion); + public function disambiguatingDescription($disambiguatingDescription); public function eligibleQuantity($eligibleQuantity); - public function eligibleTransactionVolume($eligibleTransactionVolume); - - public function maxPrice($maxPrice); - - public function minPrice($minPrice); - - public function price($price); - - public function priceCurrency($priceCurrency); - - public function validFrom($validFrom); - - public function validThrough($validThrough); - - public function valueAddedTaxIncluded($valueAddedTaxIncluded); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); + public function eligibleRegion($eligibleRegion); - public function disambiguatingDescription($disambiguatingDescription); + public function eligibleTransactionVolume($eligibleTransactionVolume); public function identifier($identifier); public function image($image); + public function ineligibleRegion($ineligibleRegion); + public function mainEntityOfPage($mainEntityOfPage); + public function maxPrice($maxPrice); + + public function minPrice($minPrice); + public function name($name); public function potentialAction($potentialAction); + public function price($price); + + public function priceCurrency($priceCurrency); + public function sameAs($sameAs); public function subjectOf($subjectOf); public function url($url); + public function validFrom($validFrom); + + public function validThrough($validThrough); + + public function valueAddedTaxIncluded($valueAddedTaxIncluded); + } diff --git a/src/Contracts/DeliveryEventContract.php b/src/Contracts/DeliveryEventContract.php index dfeeb5e41..7e3610db4 100644 --- a/src/Contracts/DeliveryEventContract.php +++ b/src/Contracts/DeliveryEventContract.php @@ -4,32 +4,38 @@ interface DeliveryEventContract { - public function accessCode($accessCode); - - public function availableFrom($availableFrom); - - public function availableThrough($availableThrough); - - public function hasDeliveryMethod($hasDeliveryMethod); - public function about($about); + public function accessCode($accessCode); + public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); public function audience($audience); + public function availableFrom($availableFrom); + + public function availableThrough($availableThrough); + public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -40,14 +46,24 @@ public function eventStatus($eventStatus); public function funder($funder); + public function hasDeliveryMethod($hasDeliveryMethod); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -56,6 +72,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -64,6 +82,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -72,38 +92,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/DemandContract.php b/src/Contracts/DemandContract.php index 12d9f6771..ebcf20155 100644 --- a/src/Contracts/DemandContract.php +++ b/src/Contracts/DemandContract.php @@ -6,8 +6,12 @@ interface DemandContract { public function acceptedPaymentMethod($acceptedPaymentMethod); + public function additionalType($additionalType); + public function advanceBookingRequirement($advanceBookingRequirement); + public function alternateName($alternateName); + public function areaServed($areaServed); public function availability($availability); @@ -24,6 +28,10 @@ public function businessFunction($businessFunction); public function deliveryLeadTime($deliveryLeadTime); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function eligibleCustomerType($eligibleCustomerType); public function eligibleDuration($eligibleDuration); @@ -42,6 +50,10 @@ public function gtin14($gtin14); public function gtin8($gtin8); + public function identifier($identifier); + + public function image($image); + public function includesObject($includesObject); public function ineligibleRegion($ineligibleRegion); @@ -52,44 +64,32 @@ public function itemCondition($itemCondition); public function itemOffered($itemOffered); + public function mainEntityOfPage($mainEntityOfPage); + public function mpn($mpn); + public function name($name); + + public function potentialAction($potentialAction); + public function priceSpecification($priceSpecification); + public function sameAs($sameAs); + public function seller($seller); public function serialNumber($serialNumber); public function sku($sku); + public function subjectOf($subjectOf); + + public function url($url); + public function validFrom($validFrom); public function validThrough($validThrough); public function warranty($warranty); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/DentistContract.php b/src/Contracts/DentistContract.php index be71f8171..4a51c44cb 100644 --- a/src/Contracts/DentistContract.php +++ b/src/Contracts/DentistContract.php @@ -4,24 +4,48 @@ interface DentistContract { + public function additionalProperty($additionalProperty); + + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -48,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -64,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -74,108 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); - public function priceRange($priceRange); - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); - - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/DepartActionContract.php b/src/Contracts/DepartActionContract.php index d50060ab3..2e4d9d274 100644 --- a/src/Contracts/DepartActionContract.php +++ b/src/Contracts/DepartActionContract.php @@ -4,54 +4,54 @@ interface DepartActionContract { - public function fromLocation($fromLocation); - - public function toLocation($toLocation); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function fromLocation($fromLocation); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function toLocation($toLocation); + public function url($url); } diff --git a/src/Contracts/DepartmentStoreContract.php b/src/Contracts/DepartmentStoreContract.php index 0f097b104..bd3070557 100644 --- a/src/Contracts/DepartmentStoreContract.php +++ b/src/Contracts/DepartmentStoreContract.php @@ -4,34 +4,48 @@ interface DepartmentStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/DepositAccountContract.php b/src/Contracts/DepositAccountContract.php index b473a7401..7a4c1d294 100644 --- a/src/Contracts/DepositAccountContract.php +++ b/src/Contracts/DepositAccountContract.php @@ -4,13 +4,15 @@ interface DepositAccountContract { - public function annualPercentageRate($annualPercentageRate); + public function additionalType($additionalType); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function aggregateRating($aggregateRating); - public function interestRate($interestRate); + public function alternateName($alternateName); - public function aggregateRating($aggregateRating); + public function amount($amount); + + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -26,18 +28,36 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -46,6 +66,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -56,30 +78,8 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); - public function amount($amount); - } diff --git a/src/Contracts/DigitalDocumentContract.php b/src/Contracts/DigitalDocumentContract.php index 9660374f1..8c5135578 100644 --- a/src/Contracts/DigitalDocumentContract.php +++ b/src/Contracts/DigitalDocumentContract.php @@ -4,8 +4,6 @@ interface DigitalDocumentContract { - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); - public function about($about); public function accessMode($accessMode); @@ -24,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -66,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -90,10 +96,16 @@ public function funder($funder); public function genre($genre); + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); + public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -120,14 +132,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -156,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,34 +192,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/DigitalDocumentPermissionContract.php b/src/Contracts/DigitalDocumentPermissionContract.php index 306239f32..f37698422 100644 --- a/src/Contracts/DigitalDocumentPermissionContract.php +++ b/src/Contracts/DigitalDocumentPermissionContract.php @@ -4,10 +4,6 @@ interface DigitalDocumentPermissionContract { - public function grantee($grantee); - - public function permissionType($permissionType); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -16,6 +12,8 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function grantee($grantee); + public function identifier($identifier); public function image($image); @@ -24,6 +22,8 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function permissionType($permissionType); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/DisagreeActionContract.php b/src/Contracts/DisagreeActionContract.php index 5f07bc145..389e8239b 100644 --- a/src/Contracts/DisagreeActionContract.php +++ b/src/Contracts/DisagreeActionContract.php @@ -6,48 +6,48 @@ interface DisagreeActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/DiscoverActionContract.php b/src/Contracts/DiscoverActionContract.php index 75e90d5e9..f7c3901e9 100644 --- a/src/Contracts/DiscoverActionContract.php +++ b/src/Contracts/DiscoverActionContract.php @@ -6,48 +6,48 @@ interface DiscoverActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/DiscussionForumPostingContract.php b/src/Contracts/DiscussionForumPostingContract.php index 70eb3a302..3b0d0a6c9 100644 --- a/src/Contracts/DiscussionForumPostingContract.php +++ b/src/Contracts/DiscussionForumPostingContract.php @@ -4,22 +4,6 @@ interface DiscussionForumPostingContract { - public function sharedContent($sharedContent); - - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -38,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -80,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -108,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -134,14 +134,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -160,16 +172,24 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function sharedContent($sharedContent); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -184,34 +204,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/DislikeActionContract.php b/src/Contracts/DislikeActionContract.php index 3d050d509..10a9e343c 100644 --- a/src/Contracts/DislikeActionContract.php +++ b/src/Contracts/DislikeActionContract.php @@ -6,48 +6,48 @@ interface DislikeActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/DistilleryContract.php b/src/Contracts/DistilleryContract.php index 1e384b1bf..bc4598ce4 100644 --- a/src/Contracts/DistilleryContract.php +++ b/src/Contracts/DistilleryContract.php @@ -6,42 +6,48 @@ interface DistilleryContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/DonateActionContract.php b/src/Contracts/DonateActionContract.php index 3aafa3346..a4b05ba2b 100644 --- a/src/Contracts/DonateActionContract.php +++ b/src/Contracts/DonateActionContract.php @@ -4,58 +4,58 @@ interface DonateActionContract { - public function recipient($recipient); + public function actionStatus($actionStatus); - public function price($price); + public function additionalType($additionalType); - public function priceCurrency($priceCurrency); + public function agent($agent); - public function priceSpecification($priceSpecification); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function description($description); - public function agent($agent); + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function price($price); - public function image($image); + public function priceCurrency($priceCurrency); - public function mainEntityOfPage($mainEntityOfPage); + public function priceSpecification($priceSpecification); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/DownloadActionContract.php b/src/Contracts/DownloadActionContract.php index dbbb2d7c3..58c99733d 100644 --- a/src/Contracts/DownloadActionContract.php +++ b/src/Contracts/DownloadActionContract.php @@ -4,54 +4,54 @@ interface DownloadActionContract { - public function fromLocation($fromLocation); - - public function toLocation($toLocation); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function fromLocation($fromLocation); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function toLocation($toLocation); + public function url($url); } diff --git a/src/Contracts/DrawActionContract.php b/src/Contracts/DrawActionContract.php index e89e5d97b..ce6e237c2 100644 --- a/src/Contracts/DrawActionContract.php +++ b/src/Contracts/DrawActionContract.php @@ -6,48 +6,48 @@ interface DrawActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/DrinkActionContract.php b/src/Contracts/DrinkActionContract.php index 9c41b4301..0d881b806 100644 --- a/src/Contracts/DrinkActionContract.php +++ b/src/Contracts/DrinkActionContract.php @@ -6,52 +6,52 @@ interface DrinkActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/DriveWheelConfigurationValueContract.php b/src/Contracts/DriveWheelConfigurationValueContract.php index d540be024..eb954756a 100644 --- a/src/Contracts/DriveWheelConfigurationValueContract.php +++ b/src/Contracts/DriveWheelConfigurationValueContract.php @@ -6,20 +6,6 @@ interface DriveWheelConfigurationValueContract { public function additionalProperty($additionalProperty); - public function equal($equal); - - public function greater($greater); - - public function greaterOrEqual($greaterOrEqual); - - public function lesser($lesser); - - public function lesserOrEqual($lesserOrEqual); - - public function nonEqual($nonEqual); - - public function valueReference($valueReference); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -28,14 +14,26 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function equal($equal); + + public function greater($greater); + + public function greaterOrEqual($greaterOrEqual); + public function identifier($identifier); public function image($image); + public function lesser($lesser); + + public function lesserOrEqual($lesserOrEqual); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function nonEqual($nonEqual); + public function potentialAction($potentialAction); public function sameAs($sameAs); @@ -44,4 +42,6 @@ public function subjectOf($subjectOf); public function url($url); + public function valueReference($valueReference); + } diff --git a/src/Contracts/DryCleaningOrLaundryContract.php b/src/Contracts/DryCleaningOrLaundryContract.php index e4130897e..ccf571e0e 100644 --- a/src/Contracts/DryCleaningOrLaundryContract.php +++ b/src/Contracts/DryCleaningOrLaundryContract.php @@ -4,34 +4,48 @@ interface DryCleaningOrLaundryContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/EatActionContract.php b/src/Contracts/EatActionContract.php index 7d73c209f..b4554891f 100644 --- a/src/Contracts/EatActionContract.php +++ b/src/Contracts/EatActionContract.php @@ -6,52 +6,52 @@ interface EatActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/EducationEventContract.php b/src/Contracts/EducationEventContract.php index e0f418dbc..c47d4629c 100644 --- a/src/Contracts/EducationEventContract.php +++ b/src/Contracts/EducationEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/EducationalAudienceContract.php b/src/Contracts/EducationalAudienceContract.php index 74d998814..b84aacfec 100644 --- a/src/Contracts/EducationalAudienceContract.php +++ b/src/Contracts/EducationalAudienceContract.php @@ -4,20 +4,20 @@ interface EducationalAudienceContract { - public function educationalRole($educationalRole); - - public function audienceType($audienceType); - - public function geographicArea($geographicArea); - public function additionalType($additionalType); public function alternateName($alternateName); + public function audienceType($audienceType); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function educationalRole($educationalRole); + + public function geographicArea($geographicArea); + public function identifier($identifier); public function image($image); diff --git a/src/Contracts/EducationalOrganizationContract.php b/src/Contracts/EducationalOrganizationContract.php index a76faf7dd..528b71b07 100644 --- a/src/Contracts/EducationalOrganizationContract.php +++ b/src/Contracts/EducationalOrganizationContract.php @@ -4,12 +4,16 @@ interface EducationalOrganizationContract { - public function alumni($alumni); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function alumni($alumni); + public function areaServed($areaServed); public function award($award); @@ -24,6 +28,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +64,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +78,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +90,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +100,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -100,34 +120,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/ElectricianContract.php b/src/Contracts/ElectricianContract.php index 767f78625..35dee6030 100644 --- a/src/Contracts/ElectricianContract.php +++ b/src/Contracts/ElectricianContract.php @@ -4,34 +4,48 @@ interface ElectricianContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ElectronicsStoreContract.php b/src/Contracts/ElectronicsStoreContract.php index db2390fb3..b6320376f 100644 --- a/src/Contracts/ElectronicsStoreContract.php +++ b/src/Contracts/ElectronicsStoreContract.php @@ -4,34 +4,48 @@ interface ElectronicsStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ElementarySchoolContract.php b/src/Contracts/ElementarySchoolContract.php index 3c0dda8f2..a137caa2c 100644 --- a/src/Contracts/ElementarySchoolContract.php +++ b/src/Contracts/ElementarySchoolContract.php @@ -4,12 +4,16 @@ interface ElementarySchoolContract { - public function alumni($alumni); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function alumni($alumni); + public function areaServed($areaServed); public function award($award); @@ -24,6 +28,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +64,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +78,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +90,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +100,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -100,34 +120,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/EmailMessageContract.php b/src/Contracts/EmailMessageContract.php index 4c0cba070..5207238c1 100644 --- a/src/Contracts/EmailMessageContract.php +++ b/src/Contracts/EmailMessageContract.php @@ -4,24 +4,6 @@ interface EmailMessageContract { - public function bccRecipient($bccRecipient); - - public function ccRecipient($ccRecipient); - - public function dateRead($dateRead); - - public function dateReceived($dateReceived); - - public function dateSent($dateSent); - - public function messageAttachment($messageAttachment); - - public function recipient($recipient); - - public function sender($sender); - - public function toRecipient($toRecipient); - public function about($about); public function accessMode($accessMode); @@ -40,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -56,6 +42,10 @@ public function award($award); public function awards($awards); + public function bccRecipient($bccRecipient); + + public function ccRecipient($ccRecipient); + public function character($character); public function citation($citation); @@ -82,6 +72,16 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function dateRead($dateRead); + + public function dateReceived($dateReceived); + + public function dateSent($dateSent); + + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -110,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,14 +140,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function messageAttachment($messageAttachment); + + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -154,6 +166,8 @@ public function publisher($publisher); public function publishingPrinciples($publishingPrinciples); + public function recipient($recipient); + public function recordedAt($recordedAt); public function releasedEvent($releasedEvent); @@ -162,8 +176,12 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function sender($sender); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -172,6 +190,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -182,38 +202,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function toRecipient($toRecipient); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/EmbassyContract.php b/src/Contracts/EmbassyContract.php index f87ccaa1f..9a8e153e0 100644 --- a/src/Contracts/EmbassyContract.php +++ b/src/Contracts/EmbassyContract.php @@ -4,14 +4,16 @@ interface EmbassyContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/EmergencyServiceContract.php b/src/Contracts/EmergencyServiceContract.php index 6305ac1ca..2c0e18a7d 100644 --- a/src/Contracts/EmergencyServiceContract.php +++ b/src/Contracts/EmergencyServiceContract.php @@ -4,34 +4,48 @@ interface EmergencyServiceContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/EmployeeRoleContract.php b/src/Contracts/EmployeeRoleContract.php index f83e17a1b..0445e021a 100644 --- a/src/Contracts/EmployeeRoleContract.php +++ b/src/Contracts/EmployeeRoleContract.php @@ -4,28 +4,18 @@ interface EmployeeRoleContract { - public function baseSalary($baseSalary); - - public function salaryCurrency($salaryCurrency); - - public function numberedPosition($numberedPosition); - - public function endDate($endDate); - - public function namedPosition($namedPosition); - - public function roleName($roleName); - - public function startDate($startDate); - public function additionalType($additionalType); public function alternateName($alternateName); + public function baseSalary($baseSalary); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endDate($endDate); + public function identifier($identifier); public function image($image); @@ -34,10 +24,20 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function namedPosition($namedPosition); + + public function numberedPosition($numberedPosition); + public function potentialAction($potentialAction); + public function roleName($roleName); + + public function salaryCurrency($salaryCurrency); + public function sameAs($sameAs); + public function startDate($startDate); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/EmployerAggregateRatingContract.php b/src/Contracts/EmployerAggregateRatingContract.php index 1ebc39741..6d9241b81 100644 --- a/src/Contracts/EmployerAggregateRatingContract.php +++ b/src/Contracts/EmployerAggregateRatingContract.php @@ -4,26 +4,14 @@ interface EmployerAggregateRatingContract { - public function itemReviewed($itemReviewed); - - public function ratingCount($ratingCount); + public function additionalType($additionalType); - public function reviewCount($reviewCount); + public function alternateName($alternateName); public function author($author); public function bestRating($bestRating); - public function ratingValue($ratingValue); - - public function reviewAspect($reviewAspect); - - public function worstRating($worstRating); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -32,16 +20,28 @@ public function identifier($identifier); public function image($image); + public function itemReviewed($itemReviewed); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function ratingCount($ratingCount); + + public function ratingValue($ratingValue); + + public function reviewAspect($reviewAspect); + + public function reviewCount($reviewCount); + public function sameAs($sameAs); public function subjectOf($subjectOf); public function url($url); + public function worstRating($worstRating); + } diff --git a/src/Contracts/EmploymentAgencyContract.php b/src/Contracts/EmploymentAgencyContract.php index f914b986e..f403604e0 100644 --- a/src/Contracts/EmploymentAgencyContract.php +++ b/src/Contracts/EmploymentAgencyContract.php @@ -4,34 +4,48 @@ interface EmploymentAgencyContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/EndorseActionContract.php b/src/Contracts/EndorseActionContract.php index 102dec2f2..41edc636c 100644 --- a/src/Contracts/EndorseActionContract.php +++ b/src/Contracts/EndorseActionContract.php @@ -4,52 +4,52 @@ interface EndorseActionContract { - public function endorsee($endorsee); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function endorsee($endorsee); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/EndorsementRatingContract.php b/src/Contracts/EndorsementRatingContract.php index 5c9c7aa1f..0d2689858 100644 --- a/src/Contracts/EndorsementRatingContract.php +++ b/src/Contracts/EndorsementRatingContract.php @@ -4,20 +4,14 @@ interface EndorsementRatingContract { - public function author($author); - - public function bestRating($bestRating); - - public function ratingValue($ratingValue); - - public function reviewAspect($reviewAspect); - - public function worstRating($worstRating); - public function additionalType($additionalType); public function alternateName($alternateName); + public function author($author); + + public function bestRating($bestRating); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -32,10 +26,16 @@ public function name($name); public function potentialAction($potentialAction); + public function ratingValue($ratingValue); + + public function reviewAspect($reviewAspect); + public function sameAs($sameAs); public function subjectOf($subjectOf); public function url($url); + public function worstRating($worstRating); + } diff --git a/src/Contracts/EngineSpecificationContract.php b/src/Contracts/EngineSpecificationContract.php index 7f8ef0d4a..869d35b06 100644 --- a/src/Contracts/EngineSpecificationContract.php +++ b/src/Contracts/EngineSpecificationContract.php @@ -4,8 +4,6 @@ interface EngineSpecificationContract { - public function fuelType($fuelType); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -14,6 +12,8 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function fuelType($fuelType); + public function identifier($identifier); public function image($image); diff --git a/src/Contracts/EntertainmentBusinessContract.php b/src/Contracts/EntertainmentBusinessContract.php index cecc8fdad..0174c1a32 100644 --- a/src/Contracts/EntertainmentBusinessContract.php +++ b/src/Contracts/EntertainmentBusinessContract.php @@ -4,34 +4,48 @@ interface EntertainmentBusinessContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/EntryPointContract.php b/src/Contracts/EntryPointContract.php index eb07d05ee..19ac0fd53 100644 --- a/src/Contracts/EntryPointContract.php +++ b/src/Contracts/EntryPointContract.php @@ -8,24 +8,22 @@ public function actionApplication($actionApplication); public function actionPlatform($actionPlatform); - public function application($application); - - public function contentType($contentType); - - public function encodingType($encodingType); - - public function httpMethod($httpMethod); - - public function urlTemplate($urlTemplate); - public function additionalType($additionalType); public function alternateName($alternateName); + public function application($application); + + public function contentType($contentType); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function encodingType($encodingType); + + public function httpMethod($httpMethod); + public function identifier($identifier); public function image($image); @@ -42,4 +40,6 @@ public function subjectOf($subjectOf); public function url($url); + public function urlTemplate($urlTemplate); + } diff --git a/src/Contracts/EpisodeContract.php b/src/Contracts/EpisodeContract.php index 3053edcfd..62d19d4b0 100644 --- a/src/Contracts/EpisodeContract.php +++ b/src/Contracts/EpisodeContract.php @@ -4,26 +4,6 @@ interface EpisodeContract { - public function actor($actor); - - public function actors($actors); - - public function director($director); - - public function directors($directors); - - public function episodeNumber($episodeNumber); - - public function musicBy($musicBy); - - public function partOfSeason($partOfSeason); - - public function partOfSeries($partOfSeries); - - public function productionCompany($productionCompany); - - public function trailer($trailer); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -84,6 +72,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -98,6 +94,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function episodeNumber($episodeNumber); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -112,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -138,16 +140,30 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function partOfSeason($partOfSeason); + + public function partOfSeries($partOfSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -164,6 +180,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -174,6 +192,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -184,38 +204,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/EventContract.php b/src/Contracts/EventContract.php index 853560fab..cbbba1262 100644 --- a/src/Contracts/EventContract.php +++ b/src/Contracts/EventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/EventReservationContract.php b/src/Contracts/EventReservationContract.php index beb313fe3..8afd9a89d 100644 --- a/src/Contracts/EventReservationContract.php +++ b/src/Contracts/EventReservationContract.php @@ -4,14 +4,32 @@ interface EventReservationContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function bookingAgent($bookingAgent); public function bookingTime($bookingTime); public function broker($broker); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function identifier($identifier); + + public function image($image); + + public function mainEntityOfPage($mainEntityOfPage); + public function modifiedTime($modifiedTime); + public function name($name); + + public function potentialAction($potentialAction); + public function priceCurrency($priceCurrency); public function programMembershipUsed($programMembershipUsed); @@ -26,32 +44,14 @@ public function reservationStatus($reservationStatus); public function reservedTicket($reservedTicket); - public function totalPrice($totalPrice); - - public function underName($underName); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - public function sameAs($sameAs); public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/EventVenueContract.php b/src/Contracts/EventVenueContract.php index 45199377e..dedf412bd 100644 --- a/src/Contracts/EventVenueContract.php +++ b/src/Contracts/EventVenueContract.php @@ -4,14 +4,16 @@ interface EventVenueContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ExerciseActionContract.php b/src/Contracts/ExerciseActionContract.php index f7983dc8d..eb62fd367 100644 --- a/src/Contracts/ExerciseActionContract.php +++ b/src/Contracts/ExerciseActionContract.php @@ -4,71 +4,71 @@ interface ExerciseActionContract { - public function course($course); + public function actionStatus($actionStatus); - public function distance($distance); + public function additionalType($additionalType); - public function exerciseCourse($exerciseCourse); + public function agent($agent); - public function fromLocation($fromLocation); + public function alternateName($alternateName); - public function opponent($opponent); + public function audience($audience); - public function sportsActivityLocation($sportsActivityLocation); + public function course($course); - public function sportsEvent($sportsEvent); + public function description($description); - public function sportsTeam($sportsTeam); + public function disambiguatingDescription($disambiguatingDescription); - public function toLocation($toLocation); + public function distance($distance); - public function audience($audience); + public function endTime($endTime); + + public function error($error); public function event($event); - public function actionStatus($actionStatus); + public function exerciseCourse($exerciseCourse); - public function agent($agent); + public function fromLocation($fromLocation); - public function endTime($endTime); + public function identifier($identifier); - public function error($error); + public function image($image); public function instrument($instrument); public function location($location); - public function object($object); - - public function participant($participant); + public function mainEntityOfPage($mainEntityOfPage); - public function result($result); + public function name($name); - public function startTime($startTime); + public function object($object); - public function target($target); + public function opponent($opponent); - public function additionalType($additionalType); + public function participant($participant); - public function alternateName($alternateName); + public function potentialAction($potentialAction); - public function description($description); + public function result($result); - public function disambiguatingDescription($disambiguatingDescription); + public function sameAs($sameAs); - public function identifier($identifier); + public function sportsActivityLocation($sportsActivityLocation); - public function image($image); + public function sportsEvent($sportsEvent); - public function mainEntityOfPage($mainEntityOfPage); + public function sportsTeam($sportsTeam); - public function name($name); + public function startTime($startTime); - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function target($target); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/ExerciseGymContract.php b/src/Contracts/ExerciseGymContract.php index 77bf529a2..09b5594b4 100644 --- a/src/Contracts/ExerciseGymContract.php +++ b/src/Contracts/ExerciseGymContract.php @@ -4,34 +4,48 @@ interface ExerciseGymContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ExhibitionEventContract.php b/src/Contracts/ExhibitionEventContract.php index 0aede47a7..303db7267 100644 --- a/src/Contracts/ExhibitionEventContract.php +++ b/src/Contracts/ExhibitionEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/FAQPageContract.php b/src/Contracts/FAQPageContract.php index 5d484cdcf..e623e89d6 100644 --- a/src/Contracts/FAQPageContract.php +++ b/src/Contracts/FAQPageContract.php @@ -4,26 +4,6 @@ interface FAQPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/FMRadioChannelContract.php b/src/Contracts/FMRadioChannelContract.php index 78451f88f..ca9d8e3c5 100644 --- a/src/Contracts/FMRadioChannelContract.php +++ b/src/Contracts/FMRadioChannelContract.php @@ -4,36 +4,36 @@ interface FMRadioChannelContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function broadcastChannelId($broadcastChannelId); public function broadcastFrequency($broadcastFrequency); public function broadcastServiceTier($broadcastServiceTier); - public function genre($genre); - - public function inBroadcastLineup($inBroadcastLineup); - - public function providesBroadcastService($providesBroadcastService); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function genre($genre); + public function identifier($identifier); public function image($image); + public function inBroadcastLineup($inBroadcastLineup); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function providesBroadcastService($providesBroadcastService); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/FastFoodRestaurantContract.php b/src/Contracts/FastFoodRestaurantContract.php index 020371f7e..d2607eb79 100644 --- a/src/Contracts/FastFoodRestaurantContract.php +++ b/src/Contracts/FastFoodRestaurantContract.php @@ -6,42 +6,48 @@ interface FastFoodRestaurantContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/FestivalContract.php b/src/Contracts/FestivalContract.php index b705a61f1..4ba91e18d 100644 --- a/src/Contracts/FestivalContract.php +++ b/src/Contracts/FestivalContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/FilmActionContract.php b/src/Contracts/FilmActionContract.php index 8684c3c68..759b84a59 100644 --- a/src/Contracts/FilmActionContract.php +++ b/src/Contracts/FilmActionContract.php @@ -6,48 +6,48 @@ interface FilmActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/FinancialProductContract.php b/src/Contracts/FinancialProductContract.php index f67a3d738..ef26233da 100644 --- a/src/Contracts/FinancialProductContract.php +++ b/src/Contracts/FinancialProductContract.php @@ -4,13 +4,13 @@ interface FinancialProductContract { - public function annualPercentageRate($annualPercentageRate); + public function additionalType($additionalType); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function aggregateRating($aggregateRating); - public function interestRate($interestRate); + public function alternateName($alternateName); - public function aggregateRating($aggregateRating); + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -26,18 +26,36 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -46,6 +64,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -56,26 +76,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/FinancialServiceContract.php b/src/Contracts/FinancialServiceContract.php index 05bcd0a69..4dd6dbefe 100644 --- a/src/Contracts/FinancialServiceContract.php +++ b/src/Contracts/FinancialServiceContract.php @@ -4,36 +4,48 @@ interface FinancialServiceContract { - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -50,6 +62,8 @@ public function events($events); public function faxNumber($faxNumber); + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function founder($founder); public function founders($founders); @@ -60,14 +74,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -76,8 +102,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -86,98 +122,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/FindActionContract.php b/src/Contracts/FindActionContract.php index b99fc6aff..9a57493e4 100644 --- a/src/Contracts/FindActionContract.php +++ b/src/Contracts/FindActionContract.php @@ -6,48 +6,48 @@ interface FindActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/FireStationContract.php b/src/Contracts/FireStationContract.php index e754e6182..ae77d4696 100644 --- a/src/Contracts/FireStationContract.php +++ b/src/Contracts/FireStationContract.php @@ -4,178 +4,178 @@ interface FireStationContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); - public function branchCode($branchCode); + public function areaServed($areaServed); - public function containedIn($containedIn); + public function award($award); - public function containedInPlace($containedInPlace); + public function awards($awards); - public function containsPlace($containsPlace); + public function branchCode($branchCode); - public function event($event); + public function branchOf($branchOf); - public function events($events); + public function brand($brand); - public function faxNumber($faxNumber); + public function contactPoint($contactPoint); - public function geo($geo); + public function contactPoints($contactPoints); - public function globalLocationNumber($globalLocationNumber); + public function containedIn($containedIn); - public function hasMap($hasMap); + public function containedInPlace($containedInPlace); - public function isAccessibleForFree($isAccessibleForFree); + public function containsPlace($containsPlace); - public function isicV4($isicV4); + public function currenciesAccepted($currenciesAccepted); - public function latitude($latitude); + public function department($department); - public function logo($logo); + public function description($description); - public function longitude($longitude); + public function disambiguatingDescription($disambiguatingDescription); - public function map($map); + public function dissolutionDate($dissolutionDate); - public function maps($maps); + public function duns($duns); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function email($email); - public function openingHoursSpecification($openingHoursSpecification); + public function employee($employee); - public function photo($photo); + public function employees($employees); - public function photos($photos); + public function event($event); - public function publicAccess($publicAccess); + public function events($events); - public function review($review); + public function faxNumber($faxNumber); - public function reviews($reviews); + public function founder($founder); - public function slogan($slogan); + public function founders($founders); - public function smokingAllowed($smokingAllowed); + public function foundingDate($foundingDate); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function foundingLocation($foundingLocation); - public function telephone($telephone); + public function funder($funder); - public function additionalType($additionalType); + public function geo($geo); - public function alternateName($alternateName); + public function globalLocationNumber($globalLocationNumber); - public function description($description); + public function hasMap($hasMap); - public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); + + public function hasPOS($hasPOS); public function identifier($identifier); public function image($image); - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); + public function isAccessibleForFree($isAccessibleForFree); - public function branchOf($branchOf); + public function isicV4($isicV4); - public function currenciesAccepted($currenciesAccepted); + public function latitude($latitude); - public function paymentAccepted($paymentAccepted); + public function legalName($legalName); - public function priceRange($priceRange); + public function leiCode($leiCode); - public function areaServed($areaServed); + public function location($location); - public function award($award); + public function logo($logo); - public function awards($awards); + public function longitude($longitude); - public function brand($brand); + public function mainEntityOfPage($mainEntityOfPage); - public function contactPoint($contactPoint); + public function makesOffer($makesOffer); - public function contactPoints($contactPoints); + public function map($map); - public function department($department); + public function maps($maps); - public function dissolutionDate($dissolutionDate); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function duns($duns); + public function member($member); - public function email($email); + public function memberOf($memberOf); - public function employee($employee); + public function members($members); - public function employees($employees); + public function naics($naics); - public function founder($founder); + public function name($name); - public function founders($founders); + public function numberOfEmployees($numberOfEmployees); - public function foundingDate($foundingDate); + public function offeredBy($offeredBy); - public function foundingLocation($foundingLocation); + public function openingHours($openingHours); - public function funder($funder); + public function openingHoursSpecification($openingHoursSpecification); - public function hasOfferCatalog($hasOfferCatalog); + public function owns($owns); - public function hasPOS($hasPOS); + public function parentOrganization($parentOrganization); - public function legalName($legalName); + public function paymentAccepted($paymentAccepted); - public function leiCode($leiCode); + public function photo($photo); - public function location($location); + public function photos($photos); - public function makesOffer($makesOffer); + public function potentialAction($potentialAction); - public function member($member); + public function priceRange($priceRange); - public function memberOf($memberOf); + public function publicAccess($publicAccess); - public function members($members); + public function publishingPrinciples($publishingPrinciples); - public function naics($naics); + public function review($review); - public function numberOfEmployees($numberOfEmployees); + public function reviews($reviews); - public function offeredBy($offeredBy); + public function sameAs($sameAs); - public function owns($owns); + public function seeks($seeks); - public function parentOrganization($parentOrganization); + public function serviceArea($serviceArea); - public function publishingPrinciples($publishingPrinciples); + public function slogan($slogan); - public function seeks($seeks); + public function smokingAllowed($smokingAllowed); - public function serviceArea($serviceArea); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); + public function telephone($telephone); + + public function url($url); + public function vatID($vatID); } diff --git a/src/Contracts/FlightContract.php b/src/Contracts/FlightContract.php index a5ff5317d..0a39f77a1 100644 --- a/src/Contracts/FlightContract.php +++ b/src/Contracts/FlightContract.php @@ -4,14 +4,20 @@ interface FlightContract { + public function additionalType($additionalType); + public function aircraft($aircraft); + public function alternateName($alternateName); + public function arrivalAirport($arrivalAirport); public function arrivalGate($arrivalGate); public function arrivalTerminal($arrivalTerminal); + public function arrivalTime($arrivalTime); + public function boardingPolicy($boardingPolicy); public function carrier($carrier); @@ -22,33 +28,17 @@ public function departureGate($departureGate); public function departureTerminal($departureTerminal); - public function estimatedFlightDuration($estimatedFlightDuration); - - public function flightDistance($flightDistance); - - public function flightNumber($flightNumber); - - public function mealService($mealService); - - public function seller($seller); - - public function webCheckinTime($webCheckinTime); - - public function arrivalTime($arrivalTime); - public function departureTime($departureTime); - public function offers($offers); - - public function provider($provider); + public function description($description); - public function additionalType($additionalType); + public function disambiguatingDescription($disambiguatingDescription); - public function alternateName($alternateName); + public function estimatedFlightDuration($estimatedFlightDuration); - public function description($description); + public function flightDistance($flightDistance); - public function disambiguatingDescription($disambiguatingDescription); + public function flightNumber($flightNumber); public function identifier($identifier); @@ -56,14 +46,24 @@ public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function mealService($mealService); + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function provider($provider); + public function sameAs($sameAs); + public function seller($seller); + public function subjectOf($subjectOf); public function url($url); + public function webCheckinTime($webCheckinTime); + } diff --git a/src/Contracts/FlightReservationContract.php b/src/Contracts/FlightReservationContract.php index a1c5f1bba..4a801a9df 100644 --- a/src/Contracts/FlightReservationContract.php +++ b/src/Contracts/FlightReservationContract.php @@ -4,11 +4,9 @@ interface FlightReservationContract { - public function passengerPriorityStatus($passengerPriorityStatus); - - public function passengerSequenceNumber($passengerSequenceNumber); + public function additionalType($additionalType); - public function securityScreening($securityScreening); + public function alternateName($alternateName); public function bookingAgent($bookingAgent); @@ -16,48 +14,50 @@ public function bookingTime($bookingTime); public function broker($broker); - public function modifiedTime($modifiedTime); - - public function priceCurrency($priceCurrency); - - public function programMembershipUsed($programMembershipUsed); + public function description($description); - public function provider($provider); + public function disambiguatingDescription($disambiguatingDescription); - public function reservationFor($reservationFor); + public function identifier($identifier); - public function reservationId($reservationId); + public function image($image); - public function reservationStatus($reservationStatus); + public function mainEntityOfPage($mainEntityOfPage); - public function reservedTicket($reservedTicket); + public function modifiedTime($modifiedTime); - public function totalPrice($totalPrice); + public function name($name); - public function underName($underName); + public function passengerPriorityStatus($passengerPriorityStatus); - public function additionalType($additionalType); + public function passengerSequenceNumber($passengerSequenceNumber); - public function alternateName($alternateName); + public function potentialAction($potentialAction); - public function description($description); + public function priceCurrency($priceCurrency); - public function disambiguatingDescription($disambiguatingDescription); + public function programMembershipUsed($programMembershipUsed); - public function identifier($identifier); + public function provider($provider); - public function image($image); + public function reservationFor($reservationFor); - public function mainEntityOfPage($mainEntityOfPage); + public function reservationId($reservationId); - public function name($name); + public function reservationStatus($reservationStatus); - public function potentialAction($potentialAction); + public function reservedTicket($reservedTicket); public function sameAs($sameAs); + public function securityScreening($securityScreening); + public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/FloristContract.php b/src/Contracts/FloristContract.php index 261ca944b..472b61740 100644 --- a/src/Contracts/FloristContract.php +++ b/src/Contracts/FloristContract.php @@ -4,34 +4,48 @@ interface FloristContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/FollowActionContract.php b/src/Contracts/FollowActionContract.php index 8e5991acd..bc86e7680 100644 --- a/src/Contracts/FollowActionContract.php +++ b/src/Contracts/FollowActionContract.php @@ -4,52 +4,52 @@ interface FollowActionContract { - public function followee($followee); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function followee($followee); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/FoodEstablishmentContract.php b/src/Contracts/FoodEstablishmentContract.php index 5b714b047..5cbff6574 100644 --- a/src/Contracts/FoodEstablishmentContract.php +++ b/src/Contracts/FoodEstablishmentContract.php @@ -6,42 +6,48 @@ interface FoodEstablishmentContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/FoodEstablishmentReservationContract.php b/src/Contracts/FoodEstablishmentReservationContract.php index 1ae73764e..03225add3 100644 --- a/src/Contracts/FoodEstablishmentReservationContract.php +++ b/src/Contracts/FoodEstablishmentReservationContract.php @@ -4,11 +4,9 @@ interface FoodEstablishmentReservationContract { - public function endTime($endTime); - - public function partySize($partySize); + public function additionalType($additionalType); - public function startTime($startTime); + public function alternateName($alternateName); public function bookingAgent($bookingAgent); @@ -16,48 +14,50 @@ public function bookingTime($bookingTime); public function broker($broker); - public function modifiedTime($modifiedTime); - - public function priceCurrency($priceCurrency); - - public function programMembershipUsed($programMembershipUsed); + public function description($description); - public function provider($provider); + public function disambiguatingDescription($disambiguatingDescription); - public function reservationFor($reservationFor); + public function endTime($endTime); - public function reservationId($reservationId); + public function identifier($identifier); - public function reservationStatus($reservationStatus); + public function image($image); - public function reservedTicket($reservedTicket); + public function mainEntityOfPage($mainEntityOfPage); - public function totalPrice($totalPrice); + public function modifiedTime($modifiedTime); - public function underName($underName); + public function name($name); - public function additionalType($additionalType); + public function partySize($partySize); - public function alternateName($alternateName); + public function potentialAction($potentialAction); - public function description($description); + public function priceCurrency($priceCurrency); - public function disambiguatingDescription($disambiguatingDescription); + public function programMembershipUsed($programMembershipUsed); - public function identifier($identifier); + public function provider($provider); - public function image($image); + public function reservationFor($reservationFor); - public function mainEntityOfPage($mainEntityOfPage); + public function reservationId($reservationId); - public function name($name); + public function reservationStatus($reservationStatus); - public function potentialAction($potentialAction); + public function reservedTicket($reservedTicket); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/FoodEventContract.php b/src/Contracts/FoodEventContract.php index a2e65e807..81ee36e34 100644 --- a/src/Contracts/FoodEventContract.php +++ b/src/Contracts/FoodEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/FoodServiceContract.php b/src/Contracts/FoodServiceContract.php index 09a3c2928..555533641 100644 --- a/src/Contracts/FoodServiceContract.php +++ b/src/Contracts/FoodServiceContract.php @@ -4,8 +4,12 @@ interface FoodServiceContract { + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function audience($audience); @@ -20,18 +24,32 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -40,6 +58,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -50,26 +70,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/FurnitureStoreContract.php b/src/Contracts/FurnitureStoreContract.php index 0c1f1896b..9bce85f28 100644 --- a/src/Contracts/FurnitureStoreContract.php +++ b/src/Contracts/FurnitureStoreContract.php @@ -4,34 +4,48 @@ interface FurnitureStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/GameContract.php b/src/Contracts/GameContract.php index 964751422..0441f4fe6 100644 --- a/src/Contracts/GameContract.php +++ b/src/Contracts/GameContract.php @@ -4,16 +4,6 @@ interface GameContract { - public function characterAttribute($characterAttribute); - - public function gameItem($gameItem); - - public function gameLocation($gameLocation); - - public function numberOfPlayers($numberOfPlayers); - - public function quest($quest); - public function about($about); public function accessMode($accessMode); @@ -32,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -50,6 +44,8 @@ public function awards($awards); public function character($character); + public function characterAttribute($characterAttribute); + public function citation($citation); public function comment($comment); @@ -74,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -96,12 +96,20 @@ public function fileFormat($fileFormat); public function funder($funder); + public function gameItem($gameItem); + + public function gameLocation($gameLocation); + public function genre($genre); public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -128,14 +136,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function numberOfPlayers($numberOfPlayers); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +162,8 @@ public function publisher($publisher); public function publishingPrinciples($publishingPrinciples); + public function quest($quest); + public function recordedAt($recordedAt); public function releasedEvent($releasedEvent); @@ -154,6 +172,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -164,6 +184,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -178,34 +200,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/GameServerContract.php b/src/Contracts/GameServerContract.php index 573150279..8fad5424d 100644 --- a/src/Contracts/GameServerContract.php +++ b/src/Contracts/GameServerContract.php @@ -4,12 +4,6 @@ interface GameServerContract { - public function game($game); - - public function playersOnline($playersOnline); - - public function serverStatus($serverStatus); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -18,6 +12,8 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function game($game); + public function identifier($identifier); public function image($image); @@ -26,10 +22,14 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function playersOnline($playersOnline); + public function potentialAction($potentialAction); public function sameAs($sameAs); + public function serverStatus($serverStatus); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/GardenStoreContract.php b/src/Contracts/GardenStoreContract.php index e7fdfc400..dbbdc3a03 100644 --- a/src/Contracts/GardenStoreContract.php +++ b/src/Contracts/GardenStoreContract.php @@ -4,34 +4,48 @@ interface GardenStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/GasStationContract.php b/src/Contracts/GasStationContract.php index 1f558d4e3..9815577a9 100644 --- a/src/Contracts/GasStationContract.php +++ b/src/Contracts/GasStationContract.php @@ -4,34 +4,48 @@ interface GasStationContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/GatedResidenceCommunityContract.php b/src/Contracts/GatedResidenceCommunityContract.php index 65458be17..2c0423944 100644 --- a/src/Contracts/GatedResidenceCommunityContract.php +++ b/src/Contracts/GatedResidenceCommunityContract.php @@ -6,10 +6,14 @@ interface GatedResidenceCommunityContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/GeneralContractorContract.php b/src/Contracts/GeneralContractorContract.php index e6fa2234e..d2d5124b4 100644 --- a/src/Contracts/GeneralContractorContract.php +++ b/src/Contracts/GeneralContractorContract.php @@ -4,34 +4,48 @@ interface GeneralContractorContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/GeoCircleContract.php b/src/Contracts/GeoCircleContract.php index ac1488302..f0d5eb701 100644 --- a/src/Contracts/GeoCircleContract.php +++ b/src/Contracts/GeoCircleContract.php @@ -4,42 +4,42 @@ interface GeoCircleContract { - public function geoRadius($geoRadius); + public function additionalType($additionalType); public function address($address); public function addressCountry($addressCountry); + public function alternateName($alternateName); + public function box($box); public function circle($circle); - public function elevation($elevation); - - public function geoMidpoint($geoMidpoint); - - public function line($line); - - public function polygon($polygon); - - public function postalCode($postalCode); + public function description($description); - public function additionalType($additionalType); + public function disambiguatingDescription($disambiguatingDescription); - public function alternateName($alternateName); + public function elevation($elevation); - public function description($description); + public function geoMidpoint($geoMidpoint); - public function disambiguatingDescription($disambiguatingDescription); + public function geoRadius($geoRadius); public function identifier($identifier); public function image($image); + public function line($line); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function polygon($polygon); + + public function postalCode($postalCode); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/GeoCoordinatesContract.php b/src/Contracts/GeoCoordinatesContract.php index 9feca8307..50a9bef78 100644 --- a/src/Contracts/GeoCoordinatesContract.php +++ b/src/Contracts/GeoCoordinatesContract.php @@ -4,34 +4,34 @@ interface GeoCoordinatesContract { + public function additionalType($additionalType); + public function address($address); public function addressCountry($addressCountry); - public function elevation($elevation); - - public function latitude($latitude); - - public function longitude($longitude); - - public function postalCode($postalCode); - - public function additionalType($additionalType); - public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function elevation($elevation); + public function identifier($identifier); public function image($image); + public function latitude($latitude); + + public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function postalCode($postalCode); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/GeoShapeContract.php b/src/Contracts/GeoShapeContract.php index 9843d699e..5fad02f73 100644 --- a/src/Contracts/GeoShapeContract.php +++ b/src/Contracts/GeoShapeContract.php @@ -4,40 +4,40 @@ interface GeoShapeContract { + public function additionalType($additionalType); + public function address($address); public function addressCountry($addressCountry); + public function alternateName($alternateName); + public function box($box); public function circle($circle); - public function elevation($elevation); - - public function geoMidpoint($geoMidpoint); - - public function line($line); - - public function polygon($polygon); - - public function postalCode($postalCode); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function elevation($elevation); + + public function geoMidpoint($geoMidpoint); + public function identifier($identifier); public function image($image); + public function line($line); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function polygon($polygon); + + public function postalCode($postalCode); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/GiveActionContract.php b/src/Contracts/GiveActionContract.php index 02f695fba..39361e681 100644 --- a/src/Contracts/GiveActionContract.php +++ b/src/Contracts/GiveActionContract.php @@ -4,55 +4,55 @@ interface GiveActionContract { - public function recipient($recipient); + public function actionStatus($actionStatus); - public function fromLocation($fromLocation); + public function additionalType($additionalType); - public function toLocation($toLocation); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); + public function fromLocation($fromLocation); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function recipient($recipient); - public function image($image); + public function result($result); - public function mainEntityOfPage($mainEntityOfPage); + public function sameAs($sameAs); - public function name($name); + public function startTime($startTime); - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function target($target); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/GolfCourseContract.php b/src/Contracts/GolfCourseContract.php index 3aad51c9e..2c6a7aa79 100644 --- a/src/Contracts/GolfCourseContract.php +++ b/src/Contracts/GolfCourseContract.php @@ -4,34 +4,48 @@ interface GolfCourseContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/GovernmentBuildingContract.php b/src/Contracts/GovernmentBuildingContract.php index cf549cce2..1f931aca0 100644 --- a/src/Contracts/GovernmentBuildingContract.php +++ b/src/Contracts/GovernmentBuildingContract.php @@ -4,14 +4,16 @@ interface GovernmentBuildingContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/GovernmentOfficeContract.php b/src/Contracts/GovernmentOfficeContract.php index 97821e815..5d8ed9d3e 100644 --- a/src/Contracts/GovernmentOfficeContract.php +++ b/src/Contracts/GovernmentOfficeContract.php @@ -4,34 +4,48 @@ interface GovernmentOfficeContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/GovernmentOrganizationContract.php b/src/Contracts/GovernmentOrganizationContract.php index 08439f930..9c6e38eab 100644 --- a/src/Contracts/GovernmentOrganizationContract.php +++ b/src/Contracts/GovernmentOrganizationContract.php @@ -4,10 +4,14 @@ interface GovernmentOrganizationContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/GovernmentPermitContract.php b/src/Contracts/GovernmentPermitContract.php index ba2275bba..dad59df76 100644 --- a/src/Contracts/GovernmentPermitContract.php +++ b/src/Contracts/GovernmentPermitContract.php @@ -4,20 +4,6 @@ interface GovernmentPermitContract { - public function issuedBy($issuedBy); - - public function issuedThrough($issuedThrough); - - public function permitAudience($permitAudience); - - public function validFor($validFor); - - public function validFrom($validFrom); - - public function validIn($validIn); - - public function validUntil($validUntil); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -30,10 +16,16 @@ public function identifier($identifier); public function image($image); + public function issuedBy($issuedBy); + + public function issuedThrough($issuedThrough); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function permitAudience($permitAudience); + public function potentialAction($potentialAction); public function sameAs($sameAs); @@ -42,4 +34,12 @@ public function subjectOf($subjectOf); public function url($url); + public function validFor($validFor); + + public function validFrom($validFrom); + + public function validIn($validIn); + + public function validUntil($validUntil); + } diff --git a/src/Contracts/GovernmentServiceContract.php b/src/Contracts/GovernmentServiceContract.php index 09638105e..9b2c36cb0 100644 --- a/src/Contracts/GovernmentServiceContract.php +++ b/src/Contracts/GovernmentServiceContract.php @@ -4,10 +4,12 @@ interface GovernmentServiceContract { - public function serviceOperator($serviceOperator); + public function additionalType($additionalType); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function audience($audience); @@ -22,18 +24,32 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -42,36 +58,20 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); + public function serviceOperator($serviceOperator); + public function serviceOutput($serviceOutput); public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/GroceryStoreContract.php b/src/Contracts/GroceryStoreContract.php index e5a3bc2df..f8253f1f8 100644 --- a/src/Contracts/GroceryStoreContract.php +++ b/src/Contracts/GroceryStoreContract.php @@ -4,34 +4,48 @@ interface GroceryStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HVACBusinessContract.php b/src/Contracts/HVACBusinessContract.php index b4bfd01e6..6566de755 100644 --- a/src/Contracts/HVACBusinessContract.php +++ b/src/Contracts/HVACBusinessContract.php @@ -4,34 +4,48 @@ interface HVACBusinessContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HairSalonContract.php b/src/Contracts/HairSalonContract.php index 722a65aaa..7a428b6e0 100644 --- a/src/Contracts/HairSalonContract.php +++ b/src/Contracts/HairSalonContract.php @@ -4,34 +4,48 @@ interface HairSalonContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HardwareStoreContract.php b/src/Contracts/HardwareStoreContract.php index ced8df89f..bd2ac8fe7 100644 --- a/src/Contracts/HardwareStoreContract.php +++ b/src/Contracts/HardwareStoreContract.php @@ -4,34 +4,48 @@ interface HardwareStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HealthAndBeautyBusinessContract.php b/src/Contracts/HealthAndBeautyBusinessContract.php index db6db5be3..d6eacdc85 100644 --- a/src/Contracts/HealthAndBeautyBusinessContract.php +++ b/src/Contracts/HealthAndBeautyBusinessContract.php @@ -4,34 +4,48 @@ interface HealthAndBeautyBusinessContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HealthClubContract.php b/src/Contracts/HealthClubContract.php index 05227fe54..18d4e8ce9 100644 --- a/src/Contracts/HealthClubContract.php +++ b/src/Contracts/HealthClubContract.php @@ -4,34 +4,48 @@ interface HealthClubContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HighSchoolContract.php b/src/Contracts/HighSchoolContract.php index 3a9385159..99f41fc55 100644 --- a/src/Contracts/HighSchoolContract.php +++ b/src/Contracts/HighSchoolContract.php @@ -4,12 +4,16 @@ interface HighSchoolContract { - public function alumni($alumni); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function alumni($alumni); + public function areaServed($areaServed); public function award($award); @@ -24,6 +28,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +64,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +78,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +90,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +100,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -100,34 +120,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/HinduTempleContract.php b/src/Contracts/HinduTempleContract.php index c18c7bfef..6240bcccb 100644 --- a/src/Contracts/HinduTempleContract.php +++ b/src/Contracts/HinduTempleContract.php @@ -4,14 +4,16 @@ interface HinduTempleContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/HobbyShopContract.php b/src/Contracts/HobbyShopContract.php index bb229a0bf..4524a097b 100644 --- a/src/Contracts/HobbyShopContract.php +++ b/src/Contracts/HobbyShopContract.php @@ -4,34 +4,48 @@ interface HobbyShopContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HomeAndConstructionBusinessContract.php b/src/Contracts/HomeAndConstructionBusinessContract.php index 8066b4033..fe07701be 100644 --- a/src/Contracts/HomeAndConstructionBusinessContract.php +++ b/src/Contracts/HomeAndConstructionBusinessContract.php @@ -4,34 +4,48 @@ interface HomeAndConstructionBusinessContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HomeGoodsStoreContract.php b/src/Contracts/HomeGoodsStoreContract.php index 8e2106333..1012d2e15 100644 --- a/src/Contracts/HomeGoodsStoreContract.php +++ b/src/Contracts/HomeGoodsStoreContract.php @@ -4,34 +4,48 @@ interface HomeGoodsStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HospitalContract.php b/src/Contracts/HospitalContract.php index 20adbb3b9..b3e4f1daf 100644 --- a/src/Contracts/HospitalContract.php +++ b/src/Contracts/HospitalContract.php @@ -4,178 +4,178 @@ interface HospitalContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); - public function branchCode($branchCode); + public function areaServed($areaServed); - public function containedIn($containedIn); + public function award($award); - public function containedInPlace($containedInPlace); + public function awards($awards); - public function containsPlace($containsPlace); + public function branchCode($branchCode); - public function event($event); + public function branchOf($branchOf); - public function events($events); + public function brand($brand); - public function faxNumber($faxNumber); + public function contactPoint($contactPoint); - public function geo($geo); + public function contactPoints($contactPoints); - public function globalLocationNumber($globalLocationNumber); + public function containedIn($containedIn); - public function hasMap($hasMap); + public function containedInPlace($containedInPlace); - public function isAccessibleForFree($isAccessibleForFree); + public function containsPlace($containsPlace); - public function isicV4($isicV4); + public function currenciesAccepted($currenciesAccepted); - public function latitude($latitude); + public function department($department); - public function logo($logo); + public function description($description); - public function longitude($longitude); + public function disambiguatingDescription($disambiguatingDescription); - public function map($map); + public function dissolutionDate($dissolutionDate); - public function maps($maps); + public function duns($duns); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function email($email); - public function openingHoursSpecification($openingHoursSpecification); + public function employee($employee); - public function photo($photo); + public function employees($employees); - public function photos($photos); + public function event($event); - public function publicAccess($publicAccess); + public function events($events); - public function review($review); + public function faxNumber($faxNumber); - public function reviews($reviews); + public function founder($founder); - public function slogan($slogan); + public function founders($founders); - public function smokingAllowed($smokingAllowed); + public function foundingDate($foundingDate); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function foundingLocation($foundingLocation); - public function telephone($telephone); + public function funder($funder); - public function additionalType($additionalType); + public function geo($geo); - public function alternateName($alternateName); + public function globalLocationNumber($globalLocationNumber); - public function description($description); + public function hasMap($hasMap); - public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); + + public function hasPOS($hasPOS); public function identifier($identifier); public function image($image); - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); + public function isAccessibleForFree($isAccessibleForFree); - public function branchOf($branchOf); + public function isicV4($isicV4); - public function currenciesAccepted($currenciesAccepted); + public function latitude($latitude); - public function paymentAccepted($paymentAccepted); + public function legalName($legalName); - public function priceRange($priceRange); + public function leiCode($leiCode); - public function areaServed($areaServed); + public function location($location); - public function award($award); + public function logo($logo); - public function awards($awards); + public function longitude($longitude); - public function brand($brand); + public function mainEntityOfPage($mainEntityOfPage); - public function contactPoint($contactPoint); + public function makesOffer($makesOffer); - public function contactPoints($contactPoints); + public function map($map); - public function department($department); + public function maps($maps); - public function dissolutionDate($dissolutionDate); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function duns($duns); + public function member($member); - public function email($email); + public function memberOf($memberOf); - public function employee($employee); + public function members($members); - public function employees($employees); + public function naics($naics); - public function founder($founder); + public function name($name); - public function founders($founders); + public function numberOfEmployees($numberOfEmployees); - public function foundingDate($foundingDate); + public function offeredBy($offeredBy); - public function foundingLocation($foundingLocation); + public function openingHours($openingHours); - public function funder($funder); + public function openingHoursSpecification($openingHoursSpecification); - public function hasOfferCatalog($hasOfferCatalog); + public function owns($owns); - public function hasPOS($hasPOS); + public function parentOrganization($parentOrganization); - public function legalName($legalName); + public function paymentAccepted($paymentAccepted); - public function leiCode($leiCode); + public function photo($photo); - public function location($location); + public function photos($photos); - public function makesOffer($makesOffer); + public function potentialAction($potentialAction); - public function member($member); + public function priceRange($priceRange); - public function memberOf($memberOf); + public function publicAccess($publicAccess); - public function members($members); + public function publishingPrinciples($publishingPrinciples); - public function naics($naics); + public function review($review); - public function numberOfEmployees($numberOfEmployees); + public function reviews($reviews); - public function offeredBy($offeredBy); + public function sameAs($sameAs); - public function owns($owns); + public function seeks($seeks); - public function parentOrganization($parentOrganization); + public function serviceArea($serviceArea); - public function publishingPrinciples($publishingPrinciples); + public function slogan($slogan); - public function seeks($seeks); + public function smokingAllowed($smokingAllowed); - public function serviceArea($serviceArea); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); + public function telephone($telephone); + + public function url($url); + public function vatID($vatID); } diff --git a/src/Contracts/HostelContract.php b/src/Contracts/HostelContract.php index 6e17dfe50..e7566e74b 100644 --- a/src/Contracts/HostelContract.php +++ b/src/Contracts/HostelContract.php @@ -4,50 +4,56 @@ interface HostelContract { - public function amenityFeature($amenityFeature); + public function additionalProperty($additionalProperty); - public function audience($audience); + public function additionalType($additionalType); - public function availableLanguage($availableLanguage); + public function address($address); - public function checkinTime($checkinTime); + public function aggregateRating($aggregateRating); - public function checkoutTime($checkoutTime); + public function alternateName($alternateName); - public function numberOfRooms($numberOfRooms); + public function amenityFeature($amenityFeature); - public function petsAllowed($petsAllowed); + public function areaServed($areaServed); - public function starRating($starRating); + public function audience($audience); - public function branchOf($branchOf); + public function availableLanguage($availableLanguage); - public function currenciesAccepted($currenciesAccepted); + public function award($award); - public function openingHours($openingHours); + public function awards($awards); - public function paymentAccepted($paymentAccepted); + public function branchCode($branchCode); - public function priceRange($priceRange); + public function branchOf($branchOf); - public function address($address); + public function brand($brand); - public function aggregateRating($aggregateRating); + public function checkinTime($checkinTime); - public function areaServed($areaServed); + public function checkoutTime($checkoutTime); - public function award($award); + public function contactPoint($contactPoint); - public function awards($awards); + public function contactPoints($contactPoints); - public function brand($brand); + public function containedIn($containedIn); - public function contactPoint($contactPoint); + public function containedInPlace($containedInPlace); - public function contactPoints($contactPoints); + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -74,14 +80,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -90,106 +108,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); + public function longitude($longitude); - public function owns($owns); + public function mainEntityOfPage($mainEntityOfPage); - public function parentOrganization($parentOrganization); + public function makesOffer($makesOffer); - public function publishingPrinciples($publishingPrinciples); + public function map($map); - public function review($review); + public function maps($maps); - public function reviews($reviews); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function seeks($seeks); + public function member($member); - public function serviceArea($serviceArea); + public function memberOf($memberOf); - public function slogan($slogan); + public function members($members); - public function sponsor($sponsor); + public function naics($naics); - public function subOrganization($subOrganization); + public function name($name); - public function taxID($taxID); + public function numberOfEmployees($numberOfEmployees); - public function telephone($telephone); + public function numberOfRooms($numberOfRooms); - public function vatID($vatID); + public function offeredBy($offeredBy); - public function additionalType($additionalType); + public function openingHours($openingHours); - public function alternateName($alternateName); + public function openingHoursSpecification($openingHoursSpecification); - public function description($description); + public function owns($owns); - public function disambiguatingDescription($disambiguatingDescription); + public function parentOrganization($parentOrganization); - public function identifier($identifier); + public function paymentAccepted($paymentAccepted); - public function image($image); + public function petsAllowed($petsAllowed); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function branchCode($branchCode); + public function publicAccess($publicAccess); - public function containedIn($containedIn); + public function publishingPrinciples($publishingPrinciples); - public function containedInPlace($containedInPlace); + public function review($review); - public function containsPlace($containsPlace); + public function reviews($reviews); - public function geo($geo); + public function sameAs($sameAs); - public function hasMap($hasMap); + public function seeks($seeks); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HotelContract.php b/src/Contracts/HotelContract.php index cc8fb8831..6827b9fd8 100644 --- a/src/Contracts/HotelContract.php +++ b/src/Contracts/HotelContract.php @@ -4,50 +4,56 @@ interface HotelContract { - public function amenityFeature($amenityFeature); + public function additionalProperty($additionalProperty); - public function audience($audience); + public function additionalType($additionalType); - public function availableLanguage($availableLanguage); + public function address($address); - public function checkinTime($checkinTime); + public function aggregateRating($aggregateRating); - public function checkoutTime($checkoutTime); + public function alternateName($alternateName); - public function numberOfRooms($numberOfRooms); + public function amenityFeature($amenityFeature); - public function petsAllowed($petsAllowed); + public function areaServed($areaServed); - public function starRating($starRating); + public function audience($audience); - public function branchOf($branchOf); + public function availableLanguage($availableLanguage); - public function currenciesAccepted($currenciesAccepted); + public function award($award); - public function openingHours($openingHours); + public function awards($awards); - public function paymentAccepted($paymentAccepted); + public function branchCode($branchCode); - public function priceRange($priceRange); + public function branchOf($branchOf); - public function address($address); + public function brand($brand); - public function aggregateRating($aggregateRating); + public function checkinTime($checkinTime); - public function areaServed($areaServed); + public function checkoutTime($checkoutTime); - public function award($award); + public function contactPoint($contactPoint); - public function awards($awards); + public function contactPoints($contactPoints); - public function brand($brand); + public function containedIn($containedIn); - public function contactPoint($contactPoint); + public function containedInPlace($containedInPlace); - public function contactPoints($contactPoints); + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -74,14 +80,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -90,106 +108,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); + public function longitude($longitude); - public function owns($owns); + public function mainEntityOfPage($mainEntityOfPage); - public function parentOrganization($parentOrganization); + public function makesOffer($makesOffer); - public function publishingPrinciples($publishingPrinciples); + public function map($map); - public function review($review); + public function maps($maps); - public function reviews($reviews); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function seeks($seeks); + public function member($member); - public function serviceArea($serviceArea); + public function memberOf($memberOf); - public function slogan($slogan); + public function members($members); - public function sponsor($sponsor); + public function naics($naics); - public function subOrganization($subOrganization); + public function name($name); - public function taxID($taxID); + public function numberOfEmployees($numberOfEmployees); - public function telephone($telephone); + public function numberOfRooms($numberOfRooms); - public function vatID($vatID); + public function offeredBy($offeredBy); - public function additionalType($additionalType); + public function openingHours($openingHours); - public function alternateName($alternateName); + public function openingHoursSpecification($openingHoursSpecification); - public function description($description); + public function owns($owns); - public function disambiguatingDescription($disambiguatingDescription); + public function parentOrganization($parentOrganization); - public function identifier($identifier); + public function paymentAccepted($paymentAccepted); - public function image($image); + public function petsAllowed($petsAllowed); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function branchCode($branchCode); + public function publicAccess($publicAccess); - public function containedIn($containedIn); + public function publishingPrinciples($publishingPrinciples); - public function containedInPlace($containedInPlace); + public function review($review); - public function containsPlace($containsPlace); + public function reviews($reviews); - public function geo($geo); + public function sameAs($sameAs); - public function hasMap($hasMap); + public function seeks($seeks); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HotelRoomContract.php b/src/Contracts/HotelRoomContract.php index 6bce66f19..b2da2b559 100644 --- a/src/Contracts/HotelRoomContract.php +++ b/src/Contracts/HotelRoomContract.php @@ -4,25 +4,19 @@ interface HotelRoomContract { - public function bed($bed); - - public function occupancy($occupancy); - - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); + public function additionalProperty($additionalProperty); - public function numberOfRooms($numberOfRooms); + public function additionalType($additionalType); - public function permittedUsage($permittedUsage); + public function address($address); - public function petsAllowed($petsAllowed); + public function aggregateRating($aggregateRating); - public function additionalProperty($additionalProperty); + public function alternateName($alternateName); - public function address($address); + public function amenityFeature($amenityFeature); - public function aggregateRating($aggregateRating); + public function bed($bed); public function branchCode($branchCode); @@ -32,18 +26,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -54,54 +58,50 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + + public function occupancy($occupancy); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/HouseContract.php b/src/Contracts/HouseContract.php index 043057d0d..3062444eb 100644 --- a/src/Contracts/HouseContract.php +++ b/src/Contracts/HouseContract.php @@ -4,24 +4,18 @@ interface HouseContract { - public function numberOfRooms($numberOfRooms); - - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); - - public function numberOfRooms($numberOfRooms); - - public function permittedUsage($permittedUsage); - - public function petsAllowed($petsAllowed); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function branchCode($branchCode); public function containedIn($containedIn); @@ -30,18 +24,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -52,54 +56,48 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/HousePainterContract.php b/src/Contracts/HousePainterContract.php index c6a26db4b..72e883b3f 100644 --- a/src/Contracts/HousePainterContract.php +++ b/src/Contracts/HousePainterContract.php @@ -4,34 +4,48 @@ interface HousePainterContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/HowToContract.php b/src/Contracts/HowToContract.php index 13389a7ad..1c476371e 100644 --- a/src/Contracts/HowToContract.php +++ b/src/Contracts/HowToContract.php @@ -4,24 +4,6 @@ interface HowToContract { - public function estimatedCost($estimatedCost); - - public function performTime($performTime); - - public function prepTime($prepTime); - - public function step($step); - - public function steps($steps); - - public function supply($supply); - - public function tool($tool); - - public function totalTime($totalTime); - - public function yield($yield); - public function about($about); public function accessMode($accessMode); @@ -40,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -82,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -96,6 +86,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function estimatedCost($estimatedCost); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -110,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,14 +132,24 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function performTime($performTime); + public function position($position); + public function potentialAction($potentialAction); + + public function prepTime($prepTime); + public function producer($producer); public function provider($provider); @@ -162,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -172,6 +180,14 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function step($step); + + public function steps($steps); + + public function subjectOf($subjectOf); + + public function supply($supply); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -182,38 +198,22 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function tool($tool); + + public function totalTime($totalTime); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); + public function yield($yield); } diff --git a/src/Contracts/HowToDirectionContract.php b/src/Contracts/HowToDirectionContract.php index fafd7328a..1a8591052 100644 --- a/src/Contracts/HowToDirectionContract.php +++ b/src/Contracts/HowToDirectionContract.php @@ -4,54 +4,6 @@ interface HowToDirectionContract { - public function afterMedia($afterMedia); - - public function beforeMedia($beforeMedia); - - public function duringMedia($duringMedia); - - public function performTime($performTime); - - public function prepTime($prepTime); - - public function supply($supply); - - public function tool($tool); - - public function totalTime($totalTime); - - public function item($item); - - public function nextItem($nextItem); - - public function position($position); - - public function previousItem($previousItem); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - public function about($about); public function accessMode($accessMode); @@ -70,8 +22,14 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + + public function afterMedia($afterMedia); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -86,6 +44,8 @@ public function award($award); public function awards($awards); + public function beforeMedia($beforeMedia); + public function character($character); public function citation($citation); @@ -112,8 +72,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duringMedia($duringMedia); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -140,6 +106,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -156,6 +126,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function item($item); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -166,12 +138,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function nextItem($nextItem); + public function offers($offers); + public function performTime($performTime); + + public function position($position); + + public function potentialAction($potentialAction); + + public function prepTime($prepTime); + + public function previousItem($previousItem); + public function producer($producer); public function provider($provider); @@ -190,6 +178,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -200,6 +190,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + + public function supply($supply); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -210,10 +204,16 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function tool($tool); + + public function totalTime($totalTime); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); diff --git a/src/Contracts/HowToItemContract.php b/src/Contracts/HowToItemContract.php index 5b8ecbe35..1e75b42cd 100644 --- a/src/Contracts/HowToItemContract.php +++ b/src/Contracts/HowToItemContract.php @@ -4,16 +4,6 @@ interface HowToItemContract { - public function requiredQuantity($requiredQuantity); - - public function item($item); - - public function nextItem($nextItem); - - public function position($position); - - public function previousItem($previousItem); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -26,12 +16,22 @@ public function identifier($identifier); public function image($image); + public function item($item); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function nextItem($nextItem); + + public function position($position); + public function potentialAction($potentialAction); + public function previousItem($previousItem); + + public function requiredQuantity($requiredQuantity); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/HowToSectionContract.php b/src/Contracts/HowToSectionContract.php index d9a079b08..d15c0b5b9 100644 --- a/src/Contracts/HowToSectionContract.php +++ b/src/Contracts/HowToSectionContract.php @@ -4,46 +4,6 @@ interface HowToSectionContract { - public function steps($steps); - - public function itemListElement($itemListElement); - - public function itemListOrder($itemListOrder); - - public function numberOfItems($numberOfItems); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function item($item); - - public function nextItem($nextItem); - - public function position($position); - - public function previousItem($previousItem); - public function about($about); public function accessMode($accessMode); @@ -62,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -104,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -132,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -148,6 +120,12 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function item($item); + + public function itemListElement($itemListElement); + + public function itemListOrder($itemListOrder); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -158,12 +136,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function nextItem($nextItem); + + public function numberOfItems($numberOfItems); + public function offers($offers); + public function position($position); + + public function potentialAction($potentialAction); + + public function previousItem($previousItem); + public function producer($producer); public function provider($provider); @@ -182,6 +174,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -192,6 +186,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function steps($steps); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -206,6 +204,8 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); diff --git a/src/Contracts/HowToStepContract.php b/src/Contracts/HowToStepContract.php index bf1c8dbd5..262cebc03 100644 --- a/src/Contracts/HowToStepContract.php +++ b/src/Contracts/HowToStepContract.php @@ -4,44 +4,6 @@ interface HowToStepContract { - public function item($item); - - public function nextItem($nextItem); - - public function position($position); - - public function previousItem($previousItem); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function itemListElement($itemListElement); - - public function itemListOrder($itemListOrder); - - public function numberOfItems($numberOfItems); - public function about($about); public function accessMode($accessMode); @@ -60,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -102,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -130,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -146,6 +120,12 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function item($item); + + public function itemListElement($itemListElement); + + public function itemListOrder($itemListOrder); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -156,12 +136,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function nextItem($nextItem); + + public function numberOfItems($numberOfItems); + public function offers($offers); + public function position($position); + + public function potentialAction($potentialAction); + + public function previousItem($previousItem); + public function producer($producer); public function provider($provider); @@ -180,6 +174,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -190,6 +186,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -204,6 +202,8 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); diff --git a/src/Contracts/HowToSupplyContract.php b/src/Contracts/HowToSupplyContract.php index b7266eb16..65b324c8f 100644 --- a/src/Contracts/HowToSupplyContract.php +++ b/src/Contracts/HowToSupplyContract.php @@ -4,18 +4,6 @@ interface HowToSupplyContract { - public function estimatedCost($estimatedCost); - - public function requiredQuantity($requiredQuantity); - - public function item($item); - - public function nextItem($nextItem); - - public function position($position); - - public function previousItem($previousItem); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -24,16 +12,28 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function estimatedCost($estimatedCost); + public function identifier($identifier); public function image($image); + public function item($item); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function nextItem($nextItem); + + public function position($position); + public function potentialAction($potentialAction); + public function previousItem($previousItem); + + public function requiredQuantity($requiredQuantity); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/HowToTipContract.php b/src/Contracts/HowToTipContract.php index f7ee5b94d..417e7ea7e 100644 --- a/src/Contracts/HowToTipContract.php +++ b/src/Contracts/HowToTipContract.php @@ -4,38 +4,6 @@ interface HowToTipContract { - public function item($item); - - public function nextItem($nextItem); - - public function position($position); - - public function previousItem($previousItem); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - public function about($about); public function accessMode($accessMode); @@ -54,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -96,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -124,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -140,6 +120,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function item($item); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -150,12 +132,24 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function nextItem($nextItem); + public function offers($offers); + public function position($position); + + public function potentialAction($potentialAction); + + public function previousItem($previousItem); + public function producer($producer); public function provider($provider); @@ -174,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -184,6 +180,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -198,6 +196,8 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); diff --git a/src/Contracts/HowToToolContract.php b/src/Contracts/HowToToolContract.php index 56d1e2dc4..27cf73702 100644 --- a/src/Contracts/HowToToolContract.php +++ b/src/Contracts/HowToToolContract.php @@ -4,16 +4,6 @@ interface HowToToolContract { - public function requiredQuantity($requiredQuantity); - - public function item($item); - - public function nextItem($nextItem); - - public function position($position); - - public function previousItem($previousItem); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -26,12 +16,22 @@ public function identifier($identifier); public function image($image); + public function item($item); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function nextItem($nextItem); + + public function position($position); + public function potentialAction($potentialAction); + public function previousItem($previousItem); + + public function requiredQuantity($requiredQuantity); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/IceCreamShopContract.php b/src/Contracts/IceCreamShopContract.php index f0a789eba..e8c418874 100644 --- a/src/Contracts/IceCreamShopContract.php +++ b/src/Contracts/IceCreamShopContract.php @@ -6,42 +6,48 @@ interface IceCreamShopContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/IgnoreActionContract.php b/src/Contracts/IgnoreActionContract.php index d385ffff2..55b0c745e 100644 --- a/src/Contracts/IgnoreActionContract.php +++ b/src/Contracts/IgnoreActionContract.php @@ -6,48 +6,48 @@ interface IgnoreActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ImageGalleryContract.php b/src/Contracts/ImageGalleryContract.php index bda614782..09bf2e4f1 100644 --- a/src/Contracts/ImageGalleryContract.php +++ b/src/Contracts/ImageGalleryContract.php @@ -4,26 +4,6 @@ interface ImageGalleryContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ImageObjectContract.php b/src/Contracts/ImageObjectContract.php index 769c0f16b..d456f6b48 100644 --- a/src/Contracts/ImageObjectContract.php +++ b/src/Contracts/ImageObjectContract.php @@ -4,48 +4,6 @@ interface ImageObjectContract { - public function caption($caption); - - public function exifData($exifData); - - public function representativeOfPage($representativeOfPage); - - public function thumbnail($thumbnail); - - public function associatedArticle($associatedArticle); - - public function bitrate($bitrate); - - public function contentSize($contentSize); - - public function contentUrl($contentUrl); - - public function duration($duration); - - public function embedUrl($embedUrl); - - public function encodesCreativeWork($encodesCreativeWork); - - public function encodingFormat($encodingFormat); - - public function endTime($endTime); - - public function height($height); - - public function playerType($playerType); - - public function productionCompany($productionCompany); - - public function regionsAllowed($regionsAllowed); - - public function requiresSubscription($requiresSubscription); - - public function startTime($startTime); - - public function uploadDate($uploadDate); - - public function width($width); - public function about($about); public function accessMode($accessMode); @@ -64,10 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function associatedArticle($associatedArticle); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -80,6 +44,10 @@ public function award($award); public function awards($awards); + public function bitrate($bitrate); + + public function caption($caption); + public function character($character); public function citation($citation); @@ -92,6 +60,10 @@ public function contentLocation($contentLocation); public function contentRating($contentRating); + public function contentSize($contentSize); + + public function contentUrl($contentUrl); + public function contributor($contributor); public function copyrightHolder($copyrightHolder); @@ -106,20 +78,36 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); public function educationalUse($educationalUse); + public function embedUrl($embedUrl); + + public function encodesCreativeWork($encodesCreativeWork); + public function encoding($encoding); + public function encodingFormat($encodingFormat); + public function encodings($encodings); + public function endTime($endTime); + public function exampleOfWork($exampleOfWork); + public function exifData($exifData); + public function expires($expires); public function fileFormat($fileFormat); @@ -132,6 +120,12 @@ public function hasPart($hasPart); public function headline($headline); + public function height($height); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -158,16 +152,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function playerType($playerType); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -178,12 +182,20 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function regionsAllowed($regionsAllowed); + public function releasedEvent($releasedEvent); + public function representativeOfPage($representativeOfPage); + + public function requiresSubscription($requiresSubscription); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -194,12 +206,18 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startTime($startTime); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); public function text($text); + public function thumbnail($thumbnail); + public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); @@ -208,34 +226,16 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function version($version); - - public function video($video); - - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); + public function uploadDate($uploadDate); - public function name($name); + public function url($url); - public function potentialAction($potentialAction); + public function version($version); - public function sameAs($sameAs); + public function video($video); - public function subjectOf($subjectOf); + public function width($width); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/IndividualProductContract.php b/src/Contracts/IndividualProductContract.php index b15b382c3..a39f02239 100644 --- a/src/Contracts/IndividualProductContract.php +++ b/src/Contracts/IndividualProductContract.php @@ -4,12 +4,14 @@ interface IndividualProductContract { - public function serialNumber($serialNumber); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function audience($audience); public function award($award); @@ -24,6 +26,10 @@ public function color($color); public function depth($depth); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function gtin12($gtin12); public function gtin13($gtin13); @@ -34,6 +40,10 @@ public function gtin8($gtin8); public function height($height); + public function identifier($identifier); + + public function image($image); + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor); public function isConsumableFor($isConsumableFor); @@ -46,6 +56,8 @@ public function itemCondition($itemCondition); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function manufacturer($manufacturer); public function material($material); @@ -54,8 +66,12 @@ public function model($model); public function mpn($mpn); + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function productID($productID); public function productionDate($productionDate); @@ -68,36 +84,20 @@ public function review($review); public function reviews($reviews); - public function sku($sku); - - public function slogan($slogan); - - public function weight($weight); - - public function width($width); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); + public function sameAs($sameAs); - public function name($name); + public function serialNumber($serialNumber); - public function potentialAction($potentialAction); + public function sku($sku); - public function sameAs($sameAs); + public function slogan($slogan); public function subjectOf($subjectOf); public function url($url); + public function weight($weight); + + public function width($width); + } diff --git a/src/Contracts/InformActionContract.php b/src/Contracts/InformActionContract.php index 18a9e5518..2171009b0 100644 --- a/src/Contracts/InformActionContract.php +++ b/src/Contracts/InformActionContract.php @@ -4,60 +4,60 @@ interface InformActionContract { - public function event($event); - public function about($about); - public function inLanguage($inLanguage); + public function actionStatus($actionStatus); - public function language($language); + public function additionalType($additionalType); - public function recipient($recipient); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function event($event); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function inLanguage($inLanguage); - public function target($target); + public function instrument($instrument); - public function additionalType($additionalType); + public function language($language); - public function alternateName($alternateName); + public function location($location); - public function description($description); + public function mainEntityOfPage($mainEntityOfPage); - public function disambiguatingDescription($disambiguatingDescription); + public function name($name); - public function identifier($identifier); + public function object($object); - public function image($image); + public function participant($participant); - public function mainEntityOfPage($mainEntityOfPage); + public function potentialAction($potentialAction); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/InsertActionContract.php b/src/Contracts/InsertActionContract.php index 046df3225..f8743d65a 100644 --- a/src/Contracts/InsertActionContract.php +++ b/src/Contracts/InsertActionContract.php @@ -4,55 +4,55 @@ interface InsertActionContract { - public function toLocation($toLocation); + public function actionStatus($actionStatus); - public function collection($collection); + public function additionalType($additionalType); - public function targetCollection($targetCollection); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function collection($collection); - public function endTime($endTime); + public function description($description); - public function error($error); + public function disambiguatingDescription($disambiguatingDescription); - public function instrument($instrument); + public function endTime($endTime); - public function location($location); + public function error($error); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function result($result); - public function image($image); + public function sameAs($sameAs); - public function mainEntityOfPage($mainEntityOfPage); + public function startTime($startTime); - public function name($name); + public function subjectOf($subjectOf); - public function potentialAction($potentialAction); + public function target($target); - public function sameAs($sameAs); + public function targetCollection($targetCollection); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/InstallActionContract.php b/src/Contracts/InstallActionContract.php index dcc0e99e7..6ca87944f 100644 --- a/src/Contracts/InstallActionContract.php +++ b/src/Contracts/InstallActionContract.php @@ -6,52 +6,52 @@ interface InstallActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/InsuranceAgencyContract.php b/src/Contracts/InsuranceAgencyContract.php index 0e0b2852d..0997b5742 100644 --- a/src/Contracts/InsuranceAgencyContract.php +++ b/src/Contracts/InsuranceAgencyContract.php @@ -4,36 +4,48 @@ interface InsuranceAgencyContract { - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -50,6 +62,8 @@ public function events($events); public function faxNumber($faxNumber); + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function founder($founder); public function founders($founders); @@ -60,14 +74,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -76,8 +102,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -86,98 +122,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/InteractActionContract.php b/src/Contracts/InteractActionContract.php index 5bdc4f1ad..8abee51f2 100644 --- a/src/Contracts/InteractActionContract.php +++ b/src/Contracts/InteractActionContract.php @@ -6,48 +6,48 @@ interface InteractActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/InteractionCounterContract.php b/src/Contracts/InteractionCounterContract.php index a441bc267..00afd5845 100644 --- a/src/Contracts/InteractionCounterContract.php +++ b/src/Contracts/InteractionCounterContract.php @@ -4,8 +4,6 @@ interface InteractionCounterContract { - public function interactionType($interactionType); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -18,6 +16,8 @@ public function identifier($identifier); public function image($image); + public function interactionType($interactionType); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); diff --git a/src/Contracts/InternetCafeContract.php b/src/Contracts/InternetCafeContract.php index a263fefe8..460d2cb91 100644 --- a/src/Contracts/InternetCafeContract.php +++ b/src/Contracts/InternetCafeContract.php @@ -4,34 +4,48 @@ interface InternetCafeContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/InvestmentOrDepositContract.php b/src/Contracts/InvestmentOrDepositContract.php index 1c0615ee4..3608c20d8 100644 --- a/src/Contracts/InvestmentOrDepositContract.php +++ b/src/Contracts/InvestmentOrDepositContract.php @@ -4,15 +4,15 @@ interface InvestmentOrDepositContract { - public function amount($amount); + public function additionalType($additionalType); - public function annualPercentageRate($annualPercentageRate); + public function aggregateRating($aggregateRating); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function alternateName($alternateName); - public function interestRate($interestRate); + public function amount($amount); - public function aggregateRating($aggregateRating); + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -28,18 +28,36 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -48,6 +66,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -58,26 +78,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/InviteActionContract.php b/src/Contracts/InviteActionContract.php index 9983b50b5..32225c18a 100644 --- a/src/Contracts/InviteActionContract.php +++ b/src/Contracts/InviteActionContract.php @@ -4,60 +4,60 @@ interface InviteActionContract { - public function event($event); - public function about($about); - public function inLanguage($inLanguage); + public function actionStatus($actionStatus); - public function language($language); + public function additionalType($additionalType); - public function recipient($recipient); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function event($event); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function inLanguage($inLanguage); - public function target($target); + public function instrument($instrument); - public function additionalType($additionalType); + public function language($language); - public function alternateName($alternateName); + public function location($location); - public function description($description); + public function mainEntityOfPage($mainEntityOfPage); - public function disambiguatingDescription($disambiguatingDescription); + public function name($name); - public function identifier($identifier); + public function object($object); - public function image($image); + public function participant($participant); - public function mainEntityOfPage($mainEntityOfPage); + public function potentialAction($potentialAction); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/InvoiceContract.php b/src/Contracts/InvoiceContract.php index 145562182..fdb40841e 100644 --- a/src/Contracts/InvoiceContract.php +++ b/src/Contracts/InvoiceContract.php @@ -6,6 +6,10 @@ interface InvoiceContract { public function accountId($accountId); + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function billingPeriod($billingPeriod); public function broker($broker); @@ -16,8 +20,20 @@ public function confirmationNumber($confirmationNumber); public function customer($customer); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function identifier($identifier); + + public function image($image); + + public function mainEntityOfPage($mainEntityOfPage); + public function minimumPaymentDue($minimumPaymentDue); + public function name($name); + public function paymentDue($paymentDue); public function paymentDueDate($paymentDueDate); @@ -28,36 +44,20 @@ public function paymentMethodId($paymentMethodId); public function paymentStatus($paymentStatus); + public function potentialAction($potentialAction); + public function provider($provider); public function referencesOrder($referencesOrder); - public function scheduledPaymentDate($scheduledPaymentDate); - - public function totalPaymentDue($totalPaymentDue); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - public function sameAs($sameAs); + public function scheduledPaymentDate($scheduledPaymentDate); + public function subjectOf($subjectOf); + public function totalPaymentDue($totalPaymentDue); + public function url($url); } diff --git a/src/Contracts/ItemListContract.php b/src/Contracts/ItemListContract.php index a972ade89..2bd709b03 100644 --- a/src/Contracts/ItemListContract.php +++ b/src/Contracts/ItemListContract.php @@ -4,12 +4,6 @@ interface ItemListContract { - public function itemListElement($itemListElement); - - public function itemListOrder($itemListOrder); - - public function numberOfItems($numberOfItems); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -22,10 +16,16 @@ public function identifier($identifier); public function image($image); + public function itemListElement($itemListElement); + + public function itemListOrder($itemListOrder); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function numberOfItems($numberOfItems); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/ItemPageContract.php b/src/Contracts/ItemPageContract.php index a1ff0ff3c..6e8b74e38 100644 --- a/src/Contracts/ItemPageContract.php +++ b/src/Contracts/ItemPageContract.php @@ -4,26 +4,6 @@ interface ItemPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/JewelryStoreContract.php b/src/Contracts/JewelryStoreContract.php index a29fba3c9..e14bbad36 100644 --- a/src/Contracts/JewelryStoreContract.php +++ b/src/Contracts/JewelryStoreContract.php @@ -4,34 +4,48 @@ interface JewelryStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/JobPostingContract.php b/src/Contracts/JobPostingContract.php index 6735ac032..7657bf7d1 100644 --- a/src/Contracts/JobPostingContract.php +++ b/src/Contracts/JobPostingContract.php @@ -4,12 +4,20 @@ interface JobPostingContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function baseSalary($baseSalary); public function benefits($benefits); public function datePosted($datePosted); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function educationRequirements($educationRequirements); public function employmentType($employmentType); @@ -20,6 +28,10 @@ public function experienceRequirements($experienceRequirements); public function hiringOrganization($hiringOrganization); + public function identifier($identifier); + + public function image($image); + public function incentiveCompensation($incentiveCompensation); public function incentives($incentives); @@ -30,8 +42,14 @@ public function jobBenefits($jobBenefits); public function jobLocation($jobLocation); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function occupationalCategory($occupationalCategory); + public function potentialAction($potentialAction); + public function qualifications($qualifications); public function relevantOccupation($relevantOccupation); @@ -40,38 +58,20 @@ public function responsibilities($responsibilities); public function salaryCurrency($salaryCurrency); + public function sameAs($sameAs); + public function skills($skills); public function specialCommitments($specialCommitments); + public function subjectOf($subjectOf); + public function title($title); + public function url($url); + public function validThrough($validThrough); public function workHours($workHours); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/JoinActionContract.php b/src/Contracts/JoinActionContract.php index 1776686a1..f6f0be62d 100644 --- a/src/Contracts/JoinActionContract.php +++ b/src/Contracts/JoinActionContract.php @@ -4,52 +4,52 @@ interface JoinActionContract { - public function event($event); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function event($event); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/LakeBodyOfWaterContract.php b/src/Contracts/LakeBodyOfWaterContract.php index 0c89692e4..7184fdfdf 100644 --- a/src/Contracts/LakeBodyOfWaterContract.php +++ b/src/Contracts/LakeBodyOfWaterContract.php @@ -6,10 +6,14 @@ interface LakeBodyOfWaterContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/LandformContract.php b/src/Contracts/LandformContract.php index a7194b9e5..ef528abd2 100644 --- a/src/Contracts/LandformContract.php +++ b/src/Contracts/LandformContract.php @@ -6,10 +6,14 @@ interface LandformContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/LandmarksOrHistoricalBuildingsContract.php b/src/Contracts/LandmarksOrHistoricalBuildingsContract.php index 5f784af41..f3f3632cf 100644 --- a/src/Contracts/LandmarksOrHistoricalBuildingsContract.php +++ b/src/Contracts/LandmarksOrHistoricalBuildingsContract.php @@ -6,10 +6,14 @@ interface LandmarksOrHistoricalBuildingsContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/LeaveActionContract.php b/src/Contracts/LeaveActionContract.php index 35c9895dd..80f2b0c9d 100644 --- a/src/Contracts/LeaveActionContract.php +++ b/src/Contracts/LeaveActionContract.php @@ -4,52 +4,52 @@ interface LeaveActionContract { - public function event($event); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function event($event); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/LegalServiceContract.php b/src/Contracts/LegalServiceContract.php index 427194c3c..ed5e2dbff 100644 --- a/src/Contracts/LegalServiceContract.php +++ b/src/Contracts/LegalServiceContract.php @@ -4,34 +4,48 @@ interface LegalServiceContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/LegislativeBuildingContract.php b/src/Contracts/LegislativeBuildingContract.php index 8d8d8c0f5..5b2f30cee 100644 --- a/src/Contracts/LegislativeBuildingContract.php +++ b/src/Contracts/LegislativeBuildingContract.php @@ -4,14 +4,16 @@ interface LegislativeBuildingContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/LendActionContract.php b/src/Contracts/LendActionContract.php index b06ad32da..ffdf17a86 100644 --- a/src/Contracts/LendActionContract.php +++ b/src/Contracts/LendActionContract.php @@ -4,56 +4,56 @@ interface LendActionContract { - public function borrower($borrower); - - public function fromLocation($fromLocation); - - public function toLocation($toLocation); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function additionalType($additionalType); - public function participant($participant); + public function agent($agent); - public function result($result); + public function alternateName($alternateName); - public function startTime($startTime); + public function borrower($borrower); - public function target($target); + public function description($description); - public function additionalType($additionalType); + public function disambiguatingDescription($disambiguatingDescription); - public function alternateName($alternateName); + public function endTime($endTime); - public function description($description); + public function error($error); - public function disambiguatingDescription($disambiguatingDescription); + public function fromLocation($fromLocation); public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function toLocation($toLocation); + public function url($url); } diff --git a/src/Contracts/LibraryContract.php b/src/Contracts/LibraryContract.php index 7299f13de..c866d514d 100644 --- a/src/Contracts/LibraryContract.php +++ b/src/Contracts/LibraryContract.php @@ -4,34 +4,48 @@ interface LibraryContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/LikeActionContract.php b/src/Contracts/LikeActionContract.php index b7752ac57..bafe6469d 100644 --- a/src/Contracts/LikeActionContract.php +++ b/src/Contracts/LikeActionContract.php @@ -6,48 +6,48 @@ interface LikeActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/LiquorStoreContract.php b/src/Contracts/LiquorStoreContract.php index 716211e16..c20289e1e 100644 --- a/src/Contracts/LiquorStoreContract.php +++ b/src/Contracts/LiquorStoreContract.php @@ -4,34 +4,48 @@ interface LiquorStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ListItemContract.php b/src/Contracts/ListItemContract.php index bd28ed463..cde14a00e 100644 --- a/src/Contracts/ListItemContract.php +++ b/src/Contracts/ListItemContract.php @@ -4,14 +4,6 @@ interface ListItemContract { - public function item($item); - - public function nextItem($nextItem); - - public function position($position); - - public function previousItem($previousItem); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -24,12 +16,20 @@ public function identifier($identifier); public function image($image); + public function item($item); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function nextItem($nextItem); + + public function position($position); + public function potentialAction($potentialAction); + public function previousItem($previousItem); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/ListenActionContract.php b/src/Contracts/ListenActionContract.php index a93f0884c..2a38f2016 100644 --- a/src/Contracts/ListenActionContract.php +++ b/src/Contracts/ListenActionContract.php @@ -6,52 +6,52 @@ interface ListenActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/LiteraryEventContract.php b/src/Contracts/LiteraryEventContract.php index d620fc5b8..3016c21a8 100644 --- a/src/Contracts/LiteraryEventContract.php +++ b/src/Contracts/LiteraryEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/LiveBlogPostingContract.php b/src/Contracts/LiveBlogPostingContract.php index 9499b5ece..3c3110928 100644 --- a/src/Contracts/LiveBlogPostingContract.php +++ b/src/Contracts/LiveBlogPostingContract.php @@ -4,28 +4,6 @@ interface LiveBlogPostingContract { - public function coverageEndTime($coverageEndTime); - - public function coverageStartTime($coverageStartTime); - - public function liveBlogUpdate($liveBlogUpdate); - - public function sharedContent($sharedContent); - - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -44,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -78,6 +64,10 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function coverageEndTime($coverageEndTime); + + public function coverageStartTime($coverageStartTime); + public function creator($creator); public function dateCreated($dateCreated); @@ -86,6 +76,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -114,6 +108,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,18 +134,32 @@ public function learningResourceType($learningResourceType); public function license($license); + public function liveBlogUpdate($liveBlogUpdate); + public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -166,16 +178,24 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function sharedContent($sharedContent); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -190,34 +210,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/LoanOrCreditContract.php b/src/Contracts/LoanOrCreditContract.php index e2781c4c4..297bd44cb 100644 --- a/src/Contracts/LoanOrCreditContract.php +++ b/src/Contracts/LoanOrCreditContract.php @@ -4,19 +4,15 @@ interface LoanOrCreditContract { - public function amount($amount); - - public function loanTerm($loanTerm); - - public function requiredCollateral($requiredCollateral); + public function additionalType($additionalType); - public function annualPercentageRate($annualPercentageRate); + public function aggregateRating($aggregateRating); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function alternateName($alternateName); - public function interestRate($interestRate); + public function amount($amount); - public function aggregateRating($aggregateRating); + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -32,26 +28,50 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); + public function loanTerm($loanTerm); + public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); public function providerMobility($providerMobility); + public function requiredCollateral($requiredCollateral); + public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -62,26 +82,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/LocalBusinessContract.php b/src/Contracts/LocalBusinessContract.php index 6e895182e..32e7387ac 100644 --- a/src/Contracts/LocalBusinessContract.php +++ b/src/Contracts/LocalBusinessContract.php @@ -4,34 +4,48 @@ interface LocalBusinessContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/LocationFeatureSpecificationContract.php b/src/Contracts/LocationFeatureSpecificationContract.php index b60c2349a..bdfefbeb5 100644 --- a/src/Contracts/LocationFeatureSpecificationContract.php +++ b/src/Contracts/LocationFeatureSpecificationContract.php @@ -4,26 +4,6 @@ interface LocationFeatureSpecificationContract { - public function hoursAvailable($hoursAvailable); - - public function validFrom($validFrom); - - public function validThrough($validThrough); - - public function maxValue($maxValue); - - public function minValue($minValue); - - public function propertyID($propertyID); - - public function unitCode($unitCode); - - public function unitText($unitText); - - public function value($value); - - public function valueReference($valueReference); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -32,20 +12,40 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function hoursAvailable($hoursAvailable); + public function identifier($identifier); public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function maxValue($maxValue); + + public function minValue($minValue); + public function name($name); public function potentialAction($potentialAction); + public function propertyID($propertyID); + public function sameAs($sameAs); public function subjectOf($subjectOf); + public function unitCode($unitCode); + + public function unitText($unitText); + public function url($url); + public function validFrom($validFrom); + + public function validThrough($validThrough); + + public function value($value); + + public function valueReference($valueReference); + } diff --git a/src/Contracts/LocksmithContract.php b/src/Contracts/LocksmithContract.php index 7af5a8c4b..0a380d358 100644 --- a/src/Contracts/LocksmithContract.php +++ b/src/Contracts/LocksmithContract.php @@ -4,34 +4,48 @@ interface LocksmithContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/LodgingBusinessContract.php b/src/Contracts/LodgingBusinessContract.php index 3e5c8f98d..5500dc583 100644 --- a/src/Contracts/LodgingBusinessContract.php +++ b/src/Contracts/LodgingBusinessContract.php @@ -4,50 +4,56 @@ interface LodgingBusinessContract { - public function amenityFeature($amenityFeature); + public function additionalProperty($additionalProperty); - public function audience($audience); + public function additionalType($additionalType); - public function availableLanguage($availableLanguage); + public function address($address); - public function checkinTime($checkinTime); + public function aggregateRating($aggregateRating); - public function checkoutTime($checkoutTime); + public function alternateName($alternateName); - public function numberOfRooms($numberOfRooms); + public function amenityFeature($amenityFeature); - public function petsAllowed($petsAllowed); + public function areaServed($areaServed); - public function starRating($starRating); + public function audience($audience); - public function branchOf($branchOf); + public function availableLanguage($availableLanguage); - public function currenciesAccepted($currenciesAccepted); + public function award($award); - public function openingHours($openingHours); + public function awards($awards); - public function paymentAccepted($paymentAccepted); + public function branchCode($branchCode); - public function priceRange($priceRange); + public function branchOf($branchOf); - public function address($address); + public function brand($brand); - public function aggregateRating($aggregateRating); + public function checkinTime($checkinTime); - public function areaServed($areaServed); + public function checkoutTime($checkoutTime); - public function award($award); + public function contactPoint($contactPoint); - public function awards($awards); + public function contactPoints($contactPoints); - public function brand($brand); + public function containedIn($containedIn); - public function contactPoint($contactPoint); + public function containedInPlace($containedInPlace); - public function contactPoints($contactPoints); + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -74,14 +80,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -90,108 +108,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); + public function longitude($longitude); - public function owns($owns); + public function mainEntityOfPage($mainEntityOfPage); - public function parentOrganization($parentOrganization); + public function makesOffer($makesOffer); - public function publishingPrinciples($publishingPrinciples); + public function map($map); - public function review($review); + public function maps($maps); - public function reviews($reviews); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function seeks($seeks); + public function member($member); - public function serviceArea($serviceArea); + public function memberOf($memberOf); - public function slogan($slogan); + public function members($members); - public function sponsor($sponsor); + public function naics($naics); - public function subOrganization($subOrganization); + public function name($name); - public function taxID($taxID); + public function numberOfEmployees($numberOfEmployees); - public function telephone($telephone); + public function numberOfRooms($numberOfRooms); - public function vatID($vatID); + public function offeredBy($offeredBy); - public function additionalType($additionalType); + public function openingHours($openingHours); - public function alternateName($alternateName); + public function openingHoursSpecification($openingHoursSpecification); - public function description($description); + public function owns($owns); - public function disambiguatingDescription($disambiguatingDescription); + public function parentOrganization($parentOrganization); - public function identifier($identifier); + public function paymentAccepted($paymentAccepted); - public function image($image); + public function petsAllowed($petsAllowed); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); + public function priceRange($priceRange); - public function branchCode($branchCode); + public function publicAccess($publicAccess); - public function containedIn($containedIn); + public function publishingPrinciples($publishingPrinciples); - public function containedInPlace($containedInPlace); + public function review($review); - public function containsPlace($containsPlace); + public function reviews($reviews); - public function geo($geo); + public function sameAs($sameAs); - public function hasMap($hasMap); + public function seeks($seeks); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/LodgingReservationContract.php b/src/Contracts/LodgingReservationContract.php index 1690191b7..97297d4c4 100644 --- a/src/Contracts/LodgingReservationContract.php +++ b/src/Contracts/LodgingReservationContract.php @@ -4,25 +4,43 @@ interface LodgingReservationContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + + public function bookingAgent($bookingAgent); + + public function bookingTime($bookingTime); + + public function broker($broker); + public function checkinTime($checkinTime); public function checkoutTime($checkoutTime); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function identifier($identifier); + + public function image($image); + public function lodgingUnitDescription($lodgingUnitDescription); public function lodgingUnitType($lodgingUnitType); - public function numAdults($numAdults); + public function mainEntityOfPage($mainEntityOfPage); - public function numChildren($numChildren); + public function modifiedTime($modifiedTime); - public function bookingAgent($bookingAgent); + public function name($name); - public function bookingTime($bookingTime); + public function numAdults($numAdults); - public function broker($broker); + public function numChildren($numChildren); - public function modifiedTime($modifiedTime); + public function potentialAction($potentialAction); public function priceCurrency($priceCurrency); @@ -38,32 +56,14 @@ public function reservationStatus($reservationStatus); public function reservedTicket($reservedTicket); - public function totalPrice($totalPrice); - - public function underName($underName); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - public function sameAs($sameAs); public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/LoseActionContract.php b/src/Contracts/LoseActionContract.php index 347b209a4..170802d09 100644 --- a/src/Contracts/LoseActionContract.php +++ b/src/Contracts/LoseActionContract.php @@ -4,52 +4,52 @@ interface LoseActionContract { - public function winner($winner); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); + public function winner($winner); + } diff --git a/src/Contracts/MapContract.php b/src/Contracts/MapContract.php index 94db209b1..1eefb52f4 100644 --- a/src/Contracts/MapContract.php +++ b/src/Contracts/MapContract.php @@ -4,8 +4,6 @@ interface MapContract { - public function mapType($mapType); - public function about($about); public function accessMode($accessMode); @@ -24,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -66,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -94,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -120,14 +130,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + + public function mapType($mapType); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -156,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,34 +192,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MarryActionContract.php b/src/Contracts/MarryActionContract.php index dfc3922fd..ae20eb4f8 100644 --- a/src/Contracts/MarryActionContract.php +++ b/src/Contracts/MarryActionContract.php @@ -6,48 +6,48 @@ interface MarryActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/MediaObjectContract.php b/src/Contracts/MediaObjectContract.php index 0b6a82750..73fcfaaf9 100644 --- a/src/Contracts/MediaObjectContract.php +++ b/src/Contracts/MediaObjectContract.php @@ -4,40 +4,6 @@ interface MediaObjectContract { - public function associatedArticle($associatedArticle); - - public function bitrate($bitrate); - - public function contentSize($contentSize); - - public function contentUrl($contentUrl); - - public function duration($duration); - - public function embedUrl($embedUrl); - - public function encodesCreativeWork($encodesCreativeWork); - - public function encodingFormat($encodingFormat); - - public function endTime($endTime); - - public function height($height); - - public function playerType($playerType); - - public function productionCompany($productionCompany); - - public function regionsAllowed($regionsAllowed); - - public function requiresSubscription($requiresSubscription); - - public function startTime($startTime); - - public function uploadDate($uploadDate); - - public function width($width); - public function about($about); public function accessMode($accessMode); @@ -56,10 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function associatedArticle($associatedArticle); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -72,6 +44,8 @@ public function award($award); public function awards($awards); + public function bitrate($bitrate); + public function character($character); public function citation($citation); @@ -84,6 +58,10 @@ public function contentLocation($contentLocation); public function contentRating($contentRating); + public function contentSize($contentSize); + + public function contentUrl($contentUrl); + public function contributor($contributor); public function copyrightHolder($copyrightHolder); @@ -98,20 +76,32 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); public function educationalUse($educationalUse); + public function embedUrl($embedUrl); + + public function encodesCreativeWork($encodesCreativeWork); + public function encoding($encoding); public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endTime($endTime); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -126,6 +116,12 @@ public function hasPart($hasPart); public function headline($headline); + public function height($height); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -152,16 +148,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function playerType($playerType); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -172,12 +178,18 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function regionsAllowed($regionsAllowed); + public function releasedEvent($releasedEvent); + public function requiresSubscription($requiresSubscription); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -188,6 +200,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startTime($startTime); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -202,34 +218,16 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function version($version); - - public function video($video); - - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); + public function uploadDate($uploadDate); - public function name($name); + public function url($url); - public function potentialAction($potentialAction); + public function version($version); - public function sameAs($sameAs); + public function video($video); - public function subjectOf($subjectOf); + public function width($width); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/MediaSubscriptionContract.php b/src/Contracts/MediaSubscriptionContract.php index 9d5e99991..affa310d1 100644 --- a/src/Contracts/MediaSubscriptionContract.php +++ b/src/Contracts/MediaSubscriptionContract.php @@ -4,18 +4,18 @@ interface MediaSubscriptionContract { - public function authenticator($authenticator); - - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function additionalType($additionalType); public function alternateName($alternateName); + public function authenticator($authenticator); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); diff --git a/src/Contracts/MedicalOrganizationContract.php b/src/Contracts/MedicalOrganizationContract.php index 8740adca9..f8044cf02 100644 --- a/src/Contracts/MedicalOrganizationContract.php +++ b/src/Contracts/MedicalOrganizationContract.php @@ -4,10 +4,14 @@ interface MedicalOrganizationContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/MeetingRoomContract.php b/src/Contracts/MeetingRoomContract.php index c92c32e22..c381e54ad 100644 --- a/src/Contracts/MeetingRoomContract.php +++ b/src/Contracts/MeetingRoomContract.php @@ -4,22 +4,18 @@ interface MeetingRoomContract { - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); - - public function numberOfRooms($numberOfRooms); - - public function permittedUsage($permittedUsage); - - public function petsAllowed($petsAllowed); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function branchCode($branchCode); public function containedIn($containedIn); @@ -28,18 +24,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -50,54 +56,48 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/MensClothingStoreContract.php b/src/Contracts/MensClothingStoreContract.php index 66ea3a141..2ebc92252 100644 --- a/src/Contracts/MensClothingStoreContract.php +++ b/src/Contracts/MensClothingStoreContract.php @@ -4,34 +4,48 @@ interface MensClothingStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/MenuContract.php b/src/Contracts/MenuContract.php index f7f66e60f..b09e77528 100644 --- a/src/Contracts/MenuContract.php +++ b/src/Contracts/MenuContract.php @@ -4,10 +4,6 @@ interface MenuContract { - public function hasMenuItem($hasMenuItem); - - public function hasMenuSection($hasMenuSection); - public function about($about); public function accessMode($accessMode); @@ -26,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -68,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,10 +96,18 @@ public function funder($funder); public function genre($genre); + public function hasMenuItem($hasMenuItem); + + public function hasMenuSection($hasMenuSection); + public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -122,14 +134,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -148,6 +166,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -158,6 +178,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -172,34 +194,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MenuItemContract.php b/src/Contracts/MenuItemContract.php index 7103cad8e..8718adef8 100644 --- a/src/Contracts/MenuItemContract.php +++ b/src/Contracts/MenuItemContract.php @@ -4,14 +4,6 @@ interface MenuItemContract { - public function menuAddOn($menuAddOn); - - public function nutrition($nutrition); - - public function offers($offers); - - public function suitableForDiet($suitableForDiet); - public function about($about); public function accessMode($accessMode); @@ -30,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -72,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -100,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -126,14 +130,24 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function menuAddOn($menuAddOn); + + public function name($name); + + public function nutrition($nutrition); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -152,6 +166,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -162,6 +178,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + + public function suitableForDiet($suitableForDiet); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -176,34 +196,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MenuSectionContract.php b/src/Contracts/MenuSectionContract.php index e330f38d9..4071b9c89 100644 --- a/src/Contracts/MenuSectionContract.php +++ b/src/Contracts/MenuSectionContract.php @@ -4,10 +4,6 @@ interface MenuSectionContract { - public function hasMenuItem($hasMenuItem); - - public function hasMenuSection($hasMenuSection); - public function about($about); public function accessMode($accessMode); @@ -26,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -68,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,10 +96,18 @@ public function funder($funder); public function genre($genre); + public function hasMenuItem($hasMenuItem); + + public function hasMenuSection($hasMenuSection); + public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -122,14 +134,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -148,6 +166,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -158,6 +178,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -172,34 +194,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MessageContract.php b/src/Contracts/MessageContract.php index d0e48f7f8..917e1634f 100644 --- a/src/Contracts/MessageContract.php +++ b/src/Contracts/MessageContract.php @@ -4,24 +4,6 @@ interface MessageContract { - public function bccRecipient($bccRecipient); - - public function ccRecipient($ccRecipient); - - public function dateRead($dateRead); - - public function dateReceived($dateReceived); - - public function dateSent($dateSent); - - public function messageAttachment($messageAttachment); - - public function recipient($recipient); - - public function sender($sender); - - public function toRecipient($toRecipient); - public function about($about); public function accessMode($accessMode); @@ -40,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -56,6 +42,10 @@ public function award($award); public function awards($awards); + public function bccRecipient($bccRecipient); + + public function ccRecipient($ccRecipient); + public function character($character); public function citation($citation); @@ -82,6 +72,16 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function dateRead($dateRead); + + public function dateReceived($dateReceived); + + public function dateSent($dateSent); + + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -110,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,14 +140,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function messageAttachment($messageAttachment); + + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -154,6 +166,8 @@ public function publisher($publisher); public function publishingPrinciples($publishingPrinciples); + public function recipient($recipient); + public function recordedAt($recordedAt); public function releasedEvent($releasedEvent); @@ -162,8 +176,12 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function sender($sender); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -172,6 +190,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -182,38 +202,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function toRecipient($toRecipient); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MiddleSchoolContract.php b/src/Contracts/MiddleSchoolContract.php index e961839c6..b3a0c2705 100644 --- a/src/Contracts/MiddleSchoolContract.php +++ b/src/Contracts/MiddleSchoolContract.php @@ -4,12 +4,16 @@ interface MiddleSchoolContract { - public function alumni($alumni); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function alumni($alumni); + public function areaServed($areaServed); public function award($award); @@ -24,6 +28,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +64,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +78,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +90,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +100,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -100,34 +120,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/MobileApplicationContract.php b/src/Contracts/MobileApplicationContract.php index 2574527d3..e7bebae18 100644 --- a/src/Contracts/MobileApplicationContract.php +++ b/src/Contracts/MobileApplicationContract.php @@ -4,56 +4,6 @@ interface MobileApplicationContract { - public function carrierRequirements($carrierRequirements); - - public function applicationCategory($applicationCategory); - - public function applicationSubCategory($applicationSubCategory); - - public function applicationSuite($applicationSuite); - - public function availableOnDevice($availableOnDevice); - - public function countriesNotSupported($countriesNotSupported); - - public function countriesSupported($countriesSupported); - - public function device($device); - - public function downloadUrl($downloadUrl); - - public function featureList($featureList); - - public function fileSize($fileSize); - - public function installUrl($installUrl); - - public function memoryRequirements($memoryRequirements); - - public function operatingSystem($operatingSystem); - - public function permissions($permissions); - - public function processorRequirements($processorRequirements); - - public function releaseNotes($releaseNotes); - - public function requirements($requirements); - - public function screenshot($screenshot); - - public function softwareAddOn($softwareAddOn); - - public function softwareHelp($softwareHelp); - - public function softwareRequirements($softwareRequirements); - - public function softwareVersion($softwareVersion); - - public function storageRequirements($storageRequirements); - - public function supportingData($supportingData); - public function about($about); public function accessMode($accessMode); @@ -72,10 +22,20 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function applicationCategory($applicationCategory); + + public function applicationSubCategory($applicationSubCategory); + + public function applicationSuite($applicationSuite); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -84,10 +44,14 @@ public function audio($audio); public function author($author); + public function availableOnDevice($availableOnDevice); + public function award($award); public function awards($awards); + public function carrierRequirements($carrierRequirements); + public function character($character); public function citation($citation); @@ -106,6 +70,10 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function countriesNotSupported($countriesNotSupported); + + public function countriesSupported($countriesSupported); + public function creator($creator); public function dateCreated($dateCreated); @@ -114,8 +82,16 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function device($device); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function downloadUrl($downloadUrl); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -132,8 +108,12 @@ public function exampleOfWork($exampleOfWork); public function expires($expires); + public function featureList($featureList); + public function fileFormat($fileFormat); + public function fileSize($fileSize); + public function funder($funder); public function genre($genre); @@ -142,8 +122,14 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function installUrl($installUrl); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -168,14 +154,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); + public function memoryRequirements($memoryRequirements); + public function mentions($mentions); + public function name($name); + public function offers($offers); + public function operatingSystem($operatingSystem); + + public function permissions($permissions); + public function position($position); + public function potentialAction($potentialAction); + + public function processorRequirements($processorRequirements); + public function producer($producer); public function provider($provider); @@ -188,14 +188,30 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function releaseNotes($releaseNotes); + public function releasedEvent($releasedEvent); + public function requirements($requirements); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function screenshot($screenshot); + + public function softwareAddOn($softwareAddOn); + + public function softwareHelp($softwareHelp); + + public function softwareRequirements($softwareRequirements); + + public function softwareVersion($softwareVersion); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -204,6 +220,12 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function storageRequirements($storageRequirements); + + public function subjectOf($subjectOf); + + public function supportingData($supportingData); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -218,34 +240,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MobilePhoneStoreContract.php b/src/Contracts/MobilePhoneStoreContract.php index f38642639..7d645c278 100644 --- a/src/Contracts/MobilePhoneStoreContract.php +++ b/src/Contracts/MobilePhoneStoreContract.php @@ -4,34 +4,48 @@ interface MobilePhoneStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/MonetaryAmountContract.php b/src/Contracts/MonetaryAmountContract.php index 4a3617715..5cf7e6473 100644 --- a/src/Contracts/MonetaryAmountContract.php +++ b/src/Contracts/MonetaryAmountContract.php @@ -4,18 +4,12 @@ interface MonetaryAmountContract { - public function currency($currency); - - public function maxValue($maxValue); - - public function minValue($minValue); - - public function value($value); - public function additionalType($additionalType); public function alternateName($alternateName); + public function currency($currency); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -26,6 +20,10 @@ public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function maxValue($maxValue); + + public function minValue($minValue); + public function name($name); public function potentialAction($potentialAction); @@ -36,4 +34,6 @@ public function subjectOf($subjectOf); public function url($url); + public function value($value); + } diff --git a/src/Contracts/MonetaryAmountDistributionContract.php b/src/Contracts/MonetaryAmountDistributionContract.php index 2dc7e5c9a..8fc086bb9 100644 --- a/src/Contracts/MonetaryAmountDistributionContract.php +++ b/src/Contracts/MonetaryAmountDistributionContract.php @@ -4,22 +4,12 @@ interface MonetaryAmountDistributionContract { - public function currency($currency); - - public function median($median); - - public function percentile10($percentile10); - - public function percentile25($percentile25); - - public function percentile75($percentile75); - - public function percentile90($percentile90); - public function additionalType($additionalType); public function alternateName($alternateName); + public function currency($currency); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -30,8 +20,18 @@ public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function median($median); + public function name($name); + public function percentile10($percentile10); + + public function percentile25($percentile25); + + public function percentile75($percentile75); + + public function percentile90($percentile90); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/MosqueContract.php b/src/Contracts/MosqueContract.php index b40281d2a..34d436d31 100644 --- a/src/Contracts/MosqueContract.php +++ b/src/Contracts/MosqueContract.php @@ -4,14 +4,16 @@ interface MosqueContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/MotelContract.php b/src/Contracts/MotelContract.php index 4a1986a86..796b1db40 100644 --- a/src/Contracts/MotelContract.php +++ b/src/Contracts/MotelContract.php @@ -4,50 +4,56 @@ interface MotelContract { - public function amenityFeature($amenityFeature); + public function additionalProperty($additionalProperty); - public function audience($audience); + public function additionalType($additionalType); - public function availableLanguage($availableLanguage); + public function address($address); - public function checkinTime($checkinTime); + public function aggregateRating($aggregateRating); - public function checkoutTime($checkoutTime); + public function alternateName($alternateName); - public function numberOfRooms($numberOfRooms); + public function amenityFeature($amenityFeature); - public function petsAllowed($petsAllowed); + public function areaServed($areaServed); - public function starRating($starRating); + public function audience($audience); - public function branchOf($branchOf); + public function availableLanguage($availableLanguage); - public function currenciesAccepted($currenciesAccepted); + public function award($award); - public function openingHours($openingHours); + public function awards($awards); - public function paymentAccepted($paymentAccepted); + public function branchCode($branchCode); - public function priceRange($priceRange); + public function branchOf($branchOf); - public function address($address); + public function brand($brand); - public function aggregateRating($aggregateRating); + public function checkinTime($checkinTime); - public function areaServed($areaServed); + public function checkoutTime($checkoutTime); - public function award($award); + public function contactPoint($contactPoint); - public function awards($awards); + public function contactPoints($contactPoints); - public function brand($brand); + public function containedIn($containedIn); - public function contactPoint($contactPoint); + public function containedInPlace($containedInPlace); - public function contactPoints($contactPoints); + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -74,14 +80,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -90,106 +108,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); + public function longitude($longitude); - public function owns($owns); + public function mainEntityOfPage($mainEntityOfPage); - public function parentOrganization($parentOrganization); + public function makesOffer($makesOffer); - public function publishingPrinciples($publishingPrinciples); + public function map($map); - public function review($review); + public function maps($maps); - public function reviews($reviews); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function seeks($seeks); + public function member($member); - public function serviceArea($serviceArea); + public function memberOf($memberOf); - public function slogan($slogan); + public function members($members); - public function sponsor($sponsor); + public function naics($naics); - public function subOrganization($subOrganization); + public function name($name); - public function taxID($taxID); + public function numberOfEmployees($numberOfEmployees); - public function telephone($telephone); + public function numberOfRooms($numberOfRooms); - public function vatID($vatID); + public function offeredBy($offeredBy); - public function additionalType($additionalType); + public function openingHours($openingHours); - public function alternateName($alternateName); + public function openingHoursSpecification($openingHoursSpecification); - public function description($description); + public function owns($owns); - public function disambiguatingDescription($disambiguatingDescription); + public function parentOrganization($parentOrganization); - public function identifier($identifier); + public function paymentAccepted($paymentAccepted); - public function image($image); + public function petsAllowed($petsAllowed); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function branchCode($branchCode); + public function publicAccess($publicAccess); - public function containedIn($containedIn); + public function publishingPrinciples($publishingPrinciples); - public function containedInPlace($containedInPlace); + public function review($review); - public function containsPlace($containsPlace); + public function reviews($reviews); - public function geo($geo); + public function sameAs($sameAs); - public function hasMap($hasMap); + public function seeks($seeks); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/MotorcycleDealerContract.php b/src/Contracts/MotorcycleDealerContract.php index bbac8f150..173f8cf24 100644 --- a/src/Contracts/MotorcycleDealerContract.php +++ b/src/Contracts/MotorcycleDealerContract.php @@ -4,34 +4,48 @@ interface MotorcycleDealerContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/MotorcycleRepairContract.php b/src/Contracts/MotorcycleRepairContract.php index e428643bc..6d39c7308 100644 --- a/src/Contracts/MotorcycleRepairContract.php +++ b/src/Contracts/MotorcycleRepairContract.php @@ -4,34 +4,48 @@ interface MotorcycleRepairContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/MountainContract.php b/src/Contracts/MountainContract.php index 3c7ee2a65..3e9e1170c 100644 --- a/src/Contracts/MountainContract.php +++ b/src/Contracts/MountainContract.php @@ -6,10 +6,14 @@ interface MountainContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/MoveActionContract.php b/src/Contracts/MoveActionContract.php index 320985949..8722d95f7 100644 --- a/src/Contracts/MoveActionContract.php +++ b/src/Contracts/MoveActionContract.php @@ -4,54 +4,54 @@ interface MoveActionContract { - public function fromLocation($fromLocation); - - public function toLocation($toLocation); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function fromLocation($fromLocation); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function toLocation($toLocation); + public function url($url); } diff --git a/src/Contracts/MovieClipContract.php b/src/Contracts/MovieClipContract.php index 3563785f7..983a87e8e 100644 --- a/src/Contracts/MovieClipContract.php +++ b/src/Contracts/MovieClipContract.php @@ -4,24 +4,6 @@ interface MovieClipContract { - public function actor($actor); - - public function actors($actors); - - public function clipNumber($clipNumber); - - public function director($director); - - public function directors($directors); - - public function musicBy($musicBy); - - public function partOfEpisode($partOfEpisode); - - public function partOfSeason($partOfSeason); - - public function partOfSeries($partOfSeries); - public function about($about); public function accessMode($accessMode); @@ -40,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -60,6 +50,8 @@ public function character($character); public function citation($citation); + public function clipNumber($clipNumber); + public function comment($comment); public function commentCount($commentCount); @@ -82,6 +74,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -110,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,14 +140,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function partOfEpisode($partOfEpisode); + + public function partOfSeason($partOfSeason); + + public function partOfSeries($partOfSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -162,6 +180,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -172,6 +192,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -186,34 +208,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MovieContract.php b/src/Contracts/MovieContract.php index 5000f9f56..bae129f64 100644 --- a/src/Contracts/MovieContract.php +++ b/src/Contracts/MovieContract.php @@ -4,26 +4,6 @@ interface MovieContract { - public function actor($actor); - - public function actors($actors); - - public function countryOfOrigin($countryOfOrigin); - - public function director($director); - - public function directors($directors); - - public function duration($duration); - - public function musicBy($musicBy); - - public function productionCompany($productionCompany); - - public function subtitleLanguage($subtitleLanguage); - - public function trailer($trailer); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -76,6 +64,8 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function countryOfOrigin($countryOfOrigin); + public function creator($creator); public function dateCreated($dateCreated); @@ -84,8 +74,18 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -112,6 +112,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -138,16 +142,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -164,6 +178,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -174,6 +190,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + + public function subtitleLanguage($subtitleLanguage); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -184,38 +204,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MovieRentalStoreContract.php b/src/Contracts/MovieRentalStoreContract.php index de2d0d59d..18c67bb97 100644 --- a/src/Contracts/MovieRentalStoreContract.php +++ b/src/Contracts/MovieRentalStoreContract.php @@ -4,34 +4,48 @@ interface MovieRentalStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/MovieSeriesContract.php b/src/Contracts/MovieSeriesContract.php index 123833b25..bd5ee8a18 100644 --- a/src/Contracts/MovieSeriesContract.php +++ b/src/Contracts/MovieSeriesContract.php @@ -4,24 +4,6 @@ interface MovieSeriesContract { - public function actor($actor); - - public function actors($actors); - - public function directors($directors); - - public function musicBy($musicBy); - - public function productionCompany($productionCompany); - - public function trailer($trailer); - - public function endDate($endDate); - - public function issn($issn); - - public function startDate($startDate); - public function about($about); public function accessMode($accessMode); @@ -40,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -82,6 +72,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -96,6 +94,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -110,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -126,6 +130,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -136,16 +142,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -162,6 +178,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -172,6 +190,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -182,40 +204,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function director($director); - } diff --git a/src/Contracts/MovieTheaterContract.php b/src/Contracts/MovieTheaterContract.php index a4b548357..76660720f 100644 --- a/src/Contracts/MovieTheaterContract.php +++ b/src/Contracts/MovieTheaterContract.php @@ -4,180 +4,180 @@ interface MovieTheaterContract { - public function screenCount($screenCount); - - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); - public function branchCode($branchCode); + public function areaServed($areaServed); - public function containedIn($containedIn); + public function award($award); - public function containedInPlace($containedInPlace); + public function awards($awards); - public function containsPlace($containsPlace); + public function branchCode($branchCode); - public function event($event); + public function branchOf($branchOf); - public function events($events); + public function brand($brand); - public function faxNumber($faxNumber); + public function contactPoint($contactPoint); - public function geo($geo); + public function contactPoints($contactPoints); - public function globalLocationNumber($globalLocationNumber); + public function containedIn($containedIn); - public function hasMap($hasMap); + public function containedInPlace($containedInPlace); - public function isAccessibleForFree($isAccessibleForFree); + public function containsPlace($containsPlace); - public function isicV4($isicV4); + public function currenciesAccepted($currenciesAccepted); - public function latitude($latitude); + public function department($department); - public function logo($logo); + public function description($description); - public function longitude($longitude); + public function disambiguatingDescription($disambiguatingDescription); - public function map($map); + public function dissolutionDate($dissolutionDate); - public function maps($maps); + public function duns($duns); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function email($email); - public function openingHoursSpecification($openingHoursSpecification); + public function employee($employee); - public function photo($photo); + public function employees($employees); - public function photos($photos); + public function event($event); - public function publicAccess($publicAccess); + public function events($events); - public function review($review); + public function faxNumber($faxNumber); - public function reviews($reviews); + public function founder($founder); - public function slogan($slogan); + public function founders($founders); - public function smokingAllowed($smokingAllowed); + public function foundingDate($foundingDate); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function foundingLocation($foundingLocation); - public function telephone($telephone); + public function funder($funder); - public function additionalType($additionalType); + public function geo($geo); - public function alternateName($alternateName); + public function globalLocationNumber($globalLocationNumber); - public function description($description); + public function hasMap($hasMap); - public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); + + public function hasPOS($hasPOS); public function identifier($identifier); public function image($image); - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function isAccessibleForFree($isAccessibleForFree); - public function url($url); + public function isicV4($isicV4); - public function branchOf($branchOf); + public function latitude($latitude); - public function currenciesAccepted($currenciesAccepted); + public function legalName($legalName); - public function paymentAccepted($paymentAccepted); + public function leiCode($leiCode); - public function priceRange($priceRange); + public function location($location); - public function areaServed($areaServed); + public function logo($logo); - public function award($award); + public function longitude($longitude); - public function awards($awards); + public function mainEntityOfPage($mainEntityOfPage); - public function brand($brand); + public function makesOffer($makesOffer); - public function contactPoint($contactPoint); + public function map($map); - public function contactPoints($contactPoints); + public function maps($maps); - public function department($department); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function dissolutionDate($dissolutionDate); + public function member($member); - public function duns($duns); + public function memberOf($memberOf); - public function email($email); + public function members($members); - public function employee($employee); + public function naics($naics); - public function employees($employees); + public function name($name); - public function founder($founder); + public function numberOfEmployees($numberOfEmployees); - public function founders($founders); + public function offeredBy($offeredBy); - public function foundingDate($foundingDate); + public function openingHours($openingHours); - public function foundingLocation($foundingLocation); + public function openingHoursSpecification($openingHoursSpecification); - public function funder($funder); + public function owns($owns); - public function hasOfferCatalog($hasOfferCatalog); + public function parentOrganization($parentOrganization); - public function hasPOS($hasPOS); + public function paymentAccepted($paymentAccepted); - public function legalName($legalName); + public function photo($photo); - public function leiCode($leiCode); + public function photos($photos); - public function location($location); + public function potentialAction($potentialAction); - public function makesOffer($makesOffer); + public function priceRange($priceRange); - public function member($member); + public function publicAccess($publicAccess); - public function memberOf($memberOf); + public function publishingPrinciples($publishingPrinciples); - public function members($members); + public function review($review); - public function naics($naics); + public function reviews($reviews); - public function numberOfEmployees($numberOfEmployees); + public function sameAs($sameAs); - public function offeredBy($offeredBy); + public function screenCount($screenCount); - public function owns($owns); + public function seeks($seeks); - public function parentOrganization($parentOrganization); + public function serviceArea($serviceArea); - public function publishingPrinciples($publishingPrinciples); + public function slogan($slogan); - public function seeks($seeks); + public function smokingAllowed($smokingAllowed); - public function serviceArea($serviceArea); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); + public function telephone($telephone); + + public function url($url); + public function vatID($vatID); } diff --git a/src/Contracts/MovingCompanyContract.php b/src/Contracts/MovingCompanyContract.php index e123ac757..f6cbf05b0 100644 --- a/src/Contracts/MovingCompanyContract.php +++ b/src/Contracts/MovingCompanyContract.php @@ -4,34 +4,48 @@ interface MovingCompanyContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/MuseumContract.php b/src/Contracts/MuseumContract.php index 8fa335402..842467ada 100644 --- a/src/Contracts/MuseumContract.php +++ b/src/Contracts/MuseumContract.php @@ -4,14 +4,16 @@ interface MuseumContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/MusicAlbumContract.php b/src/Contracts/MusicAlbumContract.php index 6d0173006..0b72c123e 100644 --- a/src/Contracts/MusicAlbumContract.php +++ b/src/Contracts/MusicAlbumContract.php @@ -4,20 +4,6 @@ interface MusicAlbumContract { - public function albumProductionType($albumProductionType); - - public function albumRelease($albumRelease); - - public function albumReleaseType($albumReleaseType); - - public function byArtist($byArtist); - - public function numTracks($numTracks); - - public function track($track); - - public function tracks($tracks); - public function about($about); public function accessMode($accessMode); @@ -36,8 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function albumProductionType($albumProductionType); + + public function albumRelease($albumRelease); + + public function albumReleaseType($albumReleaseType); + + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -52,6 +48,8 @@ public function award($award); public function awards($awards); + public function byArtist($byArtist); + public function character($character); public function citation($citation); @@ -78,6 +76,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -106,6 +108,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -132,14 +138,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function numTracks($numTracks); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -158,6 +172,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -168,6 +184,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -178,38 +196,20 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function track($track); + + public function tracks($tracks); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MusicCompositionContract.php b/src/Contracts/MusicCompositionContract.php index 1653be3e6..802d37c64 100644 --- a/src/Contracts/MusicCompositionContract.php +++ b/src/Contracts/MusicCompositionContract.php @@ -4,26 +4,6 @@ interface MusicCompositionContract { - public function composer($composer); - - public function firstPerformance($firstPerformance); - - public function includedComposition($includedComposition); - - public function iswcCode($iswcCode); - - public function lyricist($lyricist); - - public function lyrics($lyrics); - - public function musicArrangement($musicArrangement); - - public function musicCompositionForm($musicCompositionForm); - - public function musicalKey($musicalKey); - - public function recordedAs($recordedAs); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -66,6 +50,8 @@ public function comment($comment); public function commentCount($commentCount); + public function composer($composer); + public function contentLocation($contentLocation); public function contentRating($contentRating); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -104,6 +94,8 @@ public function expires($expires); public function fileFormat($fileFormat); + public function firstPerformance($firstPerformance); + public function funder($funder); public function genre($genre); @@ -112,8 +104,14 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function includedComposition($includedComposition); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -128,6 +126,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function iswcCode($iswcCode); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -136,16 +136,32 @@ public function license($license); public function locationCreated($locationCreated); + public function lyricist($lyricist); + + public function lyrics($lyrics); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicArrangement($musicArrangement); + + public function musicCompositionForm($musicCompositionForm); + + public function musicalKey($musicalKey); + + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -156,6 +172,8 @@ public function publisher($publisher); public function publishingPrinciples($publishingPrinciples); + public function recordedAs($recordedAs); + public function recordedAt($recordedAt); public function releasedEvent($releasedEvent); @@ -164,6 +182,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -174,6 +194,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MusicEventContract.php b/src/Contracts/MusicEventContract.php index 49f9420a0..cdc7f8bc2 100644 --- a/src/Contracts/MusicEventContract.php +++ b/src/Contracts/MusicEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MusicGroupContract.php b/src/Contracts/MusicGroupContract.php index 13e36c6b1..6817ecad6 100644 --- a/src/Contracts/MusicGroupContract.php +++ b/src/Contracts/MusicGroupContract.php @@ -4,21 +4,17 @@ interface MusicGroupContract { - public function album($album); - - public function albums($albums); - - public function genre($genre); + public function additionalType($additionalType); - public function musicGroupMember($musicGroupMember); + public function address($address); - public function track($track); + public function aggregateRating($aggregateRating); - public function tracks($tracks); + public function album($album); - public function address($address); + public function albums($albums); - public function aggregateRating($aggregateRating); + public function alternateName($alternateName); public function areaServed($areaServed); @@ -34,6 +30,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -60,12 +60,18 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function genre($genre); + public function globalLocationNumber($globalLocationNumber); public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -76,6 +82,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -84,8 +92,12 @@ public function memberOf($memberOf); public function members($members); + public function musicGroupMember($musicGroupMember); + public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -94,12 +106,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -110,34 +126,18 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); + public function track($track); - public function subjectOf($subjectOf); + public function tracks($tracks); public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/MusicPlaylistContract.php b/src/Contracts/MusicPlaylistContract.php index abaf511c5..7d18fa7ae 100644 --- a/src/Contracts/MusicPlaylistContract.php +++ b/src/Contracts/MusicPlaylistContract.php @@ -4,12 +4,6 @@ interface MusicPlaylistContract { - public function numTracks($numTracks); - - public function track($track); - - public function tracks($tracks); - public function about($about); public function accessMode($accessMode); @@ -28,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -70,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -98,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -124,14 +130,22 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function numTracks($numTracks); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -160,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,38 +188,20 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function track($track); + + public function tracks($tracks); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MusicRecordingContract.php b/src/Contracts/MusicRecordingContract.php index 5ee87b2d8..020ef008a 100644 --- a/src/Contracts/MusicRecordingContract.php +++ b/src/Contracts/MusicRecordingContract.php @@ -4,18 +4,6 @@ interface MusicRecordingContract { - public function byArtist($byArtist); - - public function duration($duration); - - public function inAlbum($inAlbum); - - public function inPlaylist($inPlaylist); - - public function isrcCode($isrcCode); - - public function recordingOf($recordingOf); - public function about($about); public function accessMode($accessMode); @@ -34,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -50,6 +42,8 @@ public function award($award); public function awards($awards); + public function byArtist($byArtist); + public function character($character); public function citation($citation); @@ -76,8 +70,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -104,8 +104,16 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + + public function inAlbum($inAlbum); + public function inLanguage($inLanguage); + public function inPlaylist($inPlaylist); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -120,6 +128,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function isrcCode($isrcCode); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -130,14 +140,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,12 +166,16 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function recordingOf($recordingOf); + public function releasedEvent($releasedEvent); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -166,6 +186,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -180,34 +202,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MusicReleaseContract.php b/src/Contracts/MusicReleaseContract.php index a8f64226c..6420d0322 100644 --- a/src/Contracts/MusicReleaseContract.php +++ b/src/Contracts/MusicReleaseContract.php @@ -4,22 +4,6 @@ interface MusicReleaseContract { - public function catalogNumber($catalogNumber); - - public function creditedTo($creditedTo); - - public function musicReleaseFormat($musicReleaseFormat); - - public function recordLabel($recordLabel); - - public function releaseOf($releaseOf); - - public function numTracks($numTracks); - - public function track($track); - - public function tracks($tracks); - public function about($about); public function accessMode($accessMode); @@ -38,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -54,6 +42,8 @@ public function award($award); public function awards($awards); + public function catalogNumber($catalogNumber); + public function character($character); public function citation($citation); @@ -74,12 +64,18 @@ public function copyrightYear($copyrightYear); public function creator($creator); + public function creditedTo($creditedTo); + public function dateCreated($dateCreated); public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -108,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -134,14 +134,24 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicReleaseFormat($musicReleaseFormat); + + public function name($name); + + public function numTracks($numTracks); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -152,14 +162,20 @@ public function publisher($publisher); public function publishingPrinciples($publishingPrinciples); + public function recordLabel($recordLabel); + public function recordedAt($recordedAt); + public function releaseOf($releaseOf); + public function releasedEvent($releasedEvent); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -170,6 +186,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -180,38 +198,20 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function track($track); + + public function tracks($tracks); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/MusicStoreContract.php b/src/Contracts/MusicStoreContract.php index 282d8f7f3..69cd85d37 100644 --- a/src/Contracts/MusicStoreContract.php +++ b/src/Contracts/MusicStoreContract.php @@ -4,34 +4,48 @@ interface MusicStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/MusicVenueContract.php b/src/Contracts/MusicVenueContract.php index cdbc8986e..90ef83bba 100644 --- a/src/Contracts/MusicVenueContract.php +++ b/src/Contracts/MusicVenueContract.php @@ -4,14 +4,16 @@ interface MusicVenueContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/MusicVideoObjectContract.php b/src/Contracts/MusicVideoObjectContract.php index 417c390dc..aac4ced3d 100644 --- a/src/Contracts/MusicVideoObjectContract.php +++ b/src/Contracts/MusicVideoObjectContract.php @@ -4,40 +4,6 @@ interface MusicVideoObjectContract { - public function associatedArticle($associatedArticle); - - public function bitrate($bitrate); - - public function contentSize($contentSize); - - public function contentUrl($contentUrl); - - public function duration($duration); - - public function embedUrl($embedUrl); - - public function encodesCreativeWork($encodesCreativeWork); - - public function encodingFormat($encodingFormat); - - public function endTime($endTime); - - public function height($height); - - public function playerType($playerType); - - public function productionCompany($productionCompany); - - public function regionsAllowed($regionsAllowed); - - public function requiresSubscription($requiresSubscription); - - public function startTime($startTime); - - public function uploadDate($uploadDate); - - public function width($width); - public function about($about); public function accessMode($accessMode); @@ -56,10 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function associatedArticle($associatedArticle); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -72,6 +44,8 @@ public function award($award); public function awards($awards); + public function bitrate($bitrate); + public function character($character); public function citation($citation); @@ -84,6 +58,10 @@ public function contentLocation($contentLocation); public function contentRating($contentRating); + public function contentSize($contentSize); + + public function contentUrl($contentUrl); + public function contributor($contributor); public function copyrightHolder($copyrightHolder); @@ -98,18 +76,32 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); public function educationalUse($educationalUse); + public function embedUrl($embedUrl); + + public function encodesCreativeWork($encodesCreativeWork); + public function encoding($encoding); + public function encodingFormat($encodingFormat); + public function encodings($encodings); + public function endTime($endTime); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -124,6 +116,12 @@ public function hasPart($hasPart); public function headline($headline); + public function height($height); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -150,16 +148,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function playerType($playerType); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -170,12 +178,18 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function regionsAllowed($regionsAllowed); + public function releasedEvent($releasedEvent); + public function requiresSubscription($requiresSubscription); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -186,6 +200,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startTime($startTime); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -200,34 +218,16 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function version($version); - - public function video($video); - - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); + public function uploadDate($uploadDate); - public function name($name); + public function url($url); - public function potentialAction($potentialAction); + public function version($version); - public function sameAs($sameAs); + public function video($video); - public function subjectOf($subjectOf); + public function width($width); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/NGOContract.php b/src/Contracts/NGOContract.php index 8f3f51b29..ae389f0d4 100644 --- a/src/Contracts/NGOContract.php +++ b/src/Contracts/NGOContract.php @@ -4,10 +4,14 @@ interface NGOContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/NailSalonContract.php b/src/Contracts/NailSalonContract.php index 6b3e628d8..b7f2030b0 100644 --- a/src/Contracts/NailSalonContract.php +++ b/src/Contracts/NailSalonContract.php @@ -4,34 +4,48 @@ interface NailSalonContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/NewsArticleContract.php b/src/Contracts/NewsArticleContract.php index 3fe1c83b4..fc9418bec 100644 --- a/src/Contracts/NewsArticleContract.php +++ b/src/Contracts/NewsArticleContract.php @@ -4,30 +4,6 @@ interface NewsArticleContract { - public function dateline($dateline); - - public function printColumn($printColumn); - - public function printEdition($printEdition); - - public function printPage($printPage); - - public function printSection($printSection); - - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -46,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -88,6 +72,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function dateline($dateline); + + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -116,6 +106,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -142,14 +136,34 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + + public function printColumn($printColumn); + + public function printEdition($printEdition); + + public function printPage($printPage); + + public function printSection($printSection); + public function producer($producer); public function provider($provider); @@ -168,6 +182,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -176,8 +192,12 @@ public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -192,34 +212,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/NightClubContract.php b/src/Contracts/NightClubContract.php index 439803485..053490340 100644 --- a/src/Contracts/NightClubContract.php +++ b/src/Contracts/NightClubContract.php @@ -4,34 +4,48 @@ interface NightClubContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/NotaryContract.php b/src/Contracts/NotaryContract.php index 90ac81699..f33a8ce71 100644 --- a/src/Contracts/NotaryContract.php +++ b/src/Contracts/NotaryContract.php @@ -4,34 +4,48 @@ interface NotaryContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/NoteDigitalDocumentContract.php b/src/Contracts/NoteDigitalDocumentContract.php index f612b6a84..61bf34812 100644 --- a/src/Contracts/NoteDigitalDocumentContract.php +++ b/src/Contracts/NoteDigitalDocumentContract.php @@ -4,8 +4,6 @@ interface NoteDigitalDocumentContract { - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); - public function about($about); public function accessMode($accessMode); @@ -24,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -66,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -90,10 +96,16 @@ public function funder($funder); public function genre($genre); + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); + public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -120,14 +132,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -156,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,34 +192,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/NutritionInformationContract.php b/src/Contracts/NutritionInformationContract.php index 0f6599c53..7d033a899 100644 --- a/src/Contracts/NutritionInformationContract.php +++ b/src/Contracts/NutritionInformationContract.php @@ -4,38 +4,24 @@ interface NutritionInformationContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function calories($calories); public function carbohydrateContent($carbohydrateContent); public function cholesterolContent($cholesterolContent); - public function fatContent($fatContent); - - public function fiberContent($fiberContent); - - public function proteinContent($proteinContent); - - public function saturatedFatContent($saturatedFatContent); - - public function servingSize($servingSize); - - public function sodiumContent($sodiumContent); - - public function sugarContent($sugarContent); - - public function transFatContent($transFatContent); - - public function unsaturatedFatContent($unsaturatedFatContent); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function fatContent($fatContent); + + public function fiberContent($fiberContent); + public function identifier($identifier); public function image($image); @@ -46,10 +32,24 @@ public function name($name); public function potentialAction($potentialAction); + public function proteinContent($proteinContent); + public function sameAs($sameAs); + public function saturatedFatContent($saturatedFatContent); + + public function servingSize($servingSize); + + public function sodiumContent($sodiumContent); + public function subjectOf($subjectOf); + public function sugarContent($sugarContent); + + public function transFatContent($transFatContent); + + public function unsaturatedFatContent($unsaturatedFatContent); + public function url($url); } diff --git a/src/Contracts/OccupationContract.php b/src/Contracts/OccupationContract.php index b0beb9d2c..2af9d6623 100644 --- a/src/Contracts/OccupationContract.php +++ b/src/Contracts/OccupationContract.php @@ -4,22 +4,6 @@ interface OccupationContract { - public function educationRequirements($educationRequirements); - - public function estimatedSalary($estimatedSalary); - - public function experienceRequirements($experienceRequirements); - - public function occupationLocation($occupationLocation); - - public function occupationalCategory($occupationalCategory); - - public function qualifications($qualifications); - - public function responsibilities($responsibilities); - - public function skills($skills); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -28,6 +12,12 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function educationRequirements($educationRequirements); + + public function estimatedSalary($estimatedSalary); + + public function experienceRequirements($experienceRequirements); + public function identifier($identifier); public function image($image); @@ -36,10 +26,20 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function occupationLocation($occupationLocation); + + public function occupationalCategory($occupationalCategory); + public function potentialAction($potentialAction); + public function qualifications($qualifications); + + public function responsibilities($responsibilities); + public function sameAs($sameAs); + public function skills($skills); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/OceanBodyOfWaterContract.php b/src/Contracts/OceanBodyOfWaterContract.php index 7d74446a6..8e9fe3b75 100644 --- a/src/Contracts/OceanBodyOfWaterContract.php +++ b/src/Contracts/OceanBodyOfWaterContract.php @@ -6,10 +6,14 @@ interface OceanBodyOfWaterContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/OfferCatalogContract.php b/src/Contracts/OfferCatalogContract.php index ce541f56b..eccc1e334 100644 --- a/src/Contracts/OfferCatalogContract.php +++ b/src/Contracts/OfferCatalogContract.php @@ -4,12 +4,6 @@ interface OfferCatalogContract { - public function itemListElement($itemListElement); - - public function itemListOrder($itemListOrder); - - public function numberOfItems($numberOfItems); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -22,10 +16,16 @@ public function identifier($identifier); public function image($image); + public function itemListElement($itemListElement); + + public function itemListOrder($itemListOrder); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function numberOfItems($numberOfItems); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/OfferContract.php b/src/Contracts/OfferContract.php index b37c13900..316ae7e54 100644 --- a/src/Contracts/OfferContract.php +++ b/src/Contracts/OfferContract.php @@ -8,10 +8,14 @@ public function acceptedPaymentMethod($acceptedPaymentMethod); public function addOn($addOn); + public function additionalType($additionalType); + public function advanceBookingRequirement($advanceBookingRequirement); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function availability($availability); @@ -30,6 +34,10 @@ public function category($category); public function deliveryLeadTime($deliveryLeadTime); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function eligibleCustomerType($eligibleCustomerType); public function eligibleDuration($eligibleDuration); @@ -48,6 +56,10 @@ public function gtin14($gtin14); public function gtin8($gtin8); + public function identifier($identifier); + + public function image($image); + public function includesObject($includesObject); public function ineligibleRegion($ineligibleRegion); @@ -58,8 +70,14 @@ public function itemCondition($itemCondition); public function itemOffered($itemOffered); + public function mainEntityOfPage($mainEntityOfPage); + public function mpn($mpn); + public function name($name); + + public function potentialAction($potentialAction); + public function price($price); public function priceCurrency($priceCurrency); @@ -72,40 +90,22 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seller($seller); public function serialNumber($serialNumber); public function sku($sku); + public function subjectOf($subjectOf); + + public function url($url); + public function validFrom($validFrom); public function validThrough($validThrough); public function warranty($warranty); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/OfficeEquipmentStoreContract.php b/src/Contracts/OfficeEquipmentStoreContract.php index 089e9f681..708efbd9c 100644 --- a/src/Contracts/OfficeEquipmentStoreContract.php +++ b/src/Contracts/OfficeEquipmentStoreContract.php @@ -4,34 +4,48 @@ interface OfficeEquipmentStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/OnDemandEventContract.php b/src/Contracts/OnDemandEventContract.php index 2b8befb7d..af914d125 100644 --- a/src/Contracts/OnDemandEventContract.php +++ b/src/Contracts/OnDemandEventContract.php @@ -4,18 +4,16 @@ interface OnDemandEventContract { - public function free($free); - - public function isAccessibleForFree($isAccessibleForFree); - - public function publishedOn($publishedOn); - public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -26,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -36,14 +38,26 @@ public function endDate($endDate); public function eventStatus($eventStatus); + public function free($free); + public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function isAccessibleForFree($isAccessibleForFree); + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -52,14 +66,20 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); + public function publishedOn($publishedOn); + public function recordedIn($recordedIn); public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -68,38 +88,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/OpeningHoursSpecificationContract.php b/src/Contracts/OpeningHoursSpecificationContract.php index 3a4787e8a..596380205 100644 --- a/src/Contracts/OpeningHoursSpecificationContract.php +++ b/src/Contracts/OpeningHoursSpecificationContract.php @@ -4,20 +4,14 @@ interface OpeningHoursSpecificationContract { - public function closes($closes); - - public function dayOfWeek($dayOfWeek); - - public function opens($opens); - - public function validFrom($validFrom); - - public function validThrough($validThrough); - public function additionalType($additionalType); public function alternateName($alternateName); + public function closes($closes); + + public function dayOfWeek($dayOfWeek); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -30,6 +24,8 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function opens($opens); + public function potentialAction($potentialAction); public function sameAs($sameAs); @@ -38,4 +34,8 @@ public function subjectOf($subjectOf); public function url($url); + public function validFrom($validFrom); + + public function validThrough($validThrough); + } diff --git a/src/Contracts/OrderActionContract.php b/src/Contracts/OrderActionContract.php index cdf7cd087..6495e90f6 100644 --- a/src/Contracts/OrderActionContract.php +++ b/src/Contracts/OrderActionContract.php @@ -4,58 +4,58 @@ interface OrderActionContract { - public function deliveryMethod($deliveryMethod); + public function actionStatus($actionStatus); - public function price($price); + public function additionalType($additionalType); - public function priceCurrency($priceCurrency); + public function agent($agent); - public function priceSpecification($priceSpecification); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function deliveryMethod($deliveryMethod); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function location($location); - public function additionalType($additionalType); + public function mainEntityOfPage($mainEntityOfPage); - public function alternateName($alternateName); + public function name($name); - public function description($description); + public function object($object); - public function disambiguatingDescription($disambiguatingDescription); + public function participant($participant); - public function identifier($identifier); + public function potentialAction($potentialAction); - public function image($image); + public function price($price); - public function mainEntityOfPage($mainEntityOfPage); + public function priceCurrency($priceCurrency); - public function name($name); + public function priceSpecification($priceSpecification); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/OrderContract.php b/src/Contracts/OrderContract.php index 4725ed60e..65088f9bd 100644 --- a/src/Contracts/OrderContract.php +++ b/src/Contracts/OrderContract.php @@ -6,6 +6,10 @@ interface OrderContract { public function acceptedOffer($acceptedOffer); + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function billingAddress($billingAddress); public function broker($broker); @@ -14,16 +18,28 @@ public function confirmationNumber($confirmationNumber); public function customer($customer); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discount($discount); public function discountCode($discountCode); public function discountCurrency($discountCurrency); + public function identifier($identifier); + + public function image($image); + public function isGift($isGift); + public function mainEntityOfPage($mainEntityOfPage); + public function merchant($merchant); + public function name($name); + public function orderDate($orderDate); public function orderDelivery($orderDelivery); @@ -46,28 +62,12 @@ public function paymentMethodId($paymentMethodId); public function paymentUrl($paymentUrl); - public function seller($seller); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - public function potentialAction($potentialAction); public function sameAs($sameAs); + public function seller($seller); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/OrderItemContract.php b/src/Contracts/OrderItemContract.php index 4900b8d4f..7e0e1a080 100644 --- a/src/Contracts/OrderItemContract.php +++ b/src/Contracts/OrderItemContract.php @@ -4,16 +4,6 @@ interface OrderItemContract { - public function orderDelivery($orderDelivery); - - public function orderItemNumber($orderItemNumber); - - public function orderItemStatus($orderItemStatus); - - public function orderQuantity($orderQuantity); - - public function orderedItem($orderedItem); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -30,6 +20,16 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function orderDelivery($orderDelivery); + + public function orderItemNumber($orderItemNumber); + + public function orderItemStatus($orderItemStatus); + + public function orderQuantity($orderQuantity); + + public function orderedItem($orderedItem); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/OrganizationContract.php b/src/Contracts/OrganizationContract.php index 4f24356d4..d4ee2d8ff 100644 --- a/src/Contracts/OrganizationContract.php +++ b/src/Contracts/OrganizationContract.php @@ -4,10 +4,14 @@ interface OrganizationContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/OrganizationRoleContract.php b/src/Contracts/OrganizationRoleContract.php index 3f1173b99..e81050e21 100644 --- a/src/Contracts/OrganizationRoleContract.php +++ b/src/Contracts/OrganizationRoleContract.php @@ -4,16 +4,6 @@ interface OrganizationRoleContract { - public function numberedPosition($numberedPosition); - - public function endDate($endDate); - - public function namedPosition($namedPosition); - - public function roleName($roleName); - - public function startDate($startDate); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -22,6 +12,8 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endDate($endDate); + public function identifier($identifier); public function image($image); @@ -30,10 +22,18 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function namedPosition($namedPosition); + + public function numberedPosition($numberedPosition); + public function potentialAction($potentialAction); + public function roleName($roleName); + public function sameAs($sameAs); + public function startDate($startDate); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/OrganizeActionContract.php b/src/Contracts/OrganizeActionContract.php index 74db7034f..1a0746263 100644 --- a/src/Contracts/OrganizeActionContract.php +++ b/src/Contracts/OrganizeActionContract.php @@ -6,48 +6,48 @@ interface OrganizeActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/OutletStoreContract.php b/src/Contracts/OutletStoreContract.php index 626becf13..5b2417a9b 100644 --- a/src/Contracts/OutletStoreContract.php +++ b/src/Contracts/OutletStoreContract.php @@ -4,34 +4,48 @@ interface OutletStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/OwnershipInfoContract.php b/src/Contracts/OwnershipInfoContract.php index 5ab727b89..cb2d547ba 100644 --- a/src/Contracts/OwnershipInfoContract.php +++ b/src/Contracts/OwnershipInfoContract.php @@ -6,12 +6,6 @@ interface OwnershipInfoContract { public function acquiredFrom($acquiredFrom); - public function ownedFrom($ownedFrom); - - public function ownedThrough($ownedThrough); - - public function typeOfGood($typeOfGood); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -28,12 +22,18 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function ownedFrom($ownedFrom); + + public function ownedThrough($ownedThrough); + public function potentialAction($potentialAction); public function sameAs($sameAs); public function subjectOf($subjectOf); + public function typeOfGood($typeOfGood); + public function url($url); } diff --git a/src/Contracts/PaintActionContract.php b/src/Contracts/PaintActionContract.php index cf240f6b3..4d95aa627 100644 --- a/src/Contracts/PaintActionContract.php +++ b/src/Contracts/PaintActionContract.php @@ -6,48 +6,48 @@ interface PaintActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/PaintingContract.php b/src/Contracts/PaintingContract.php index 4a62c81c2..e2087f8eb 100644 --- a/src/Contracts/PaintingContract.php +++ b/src/Contracts/PaintingContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ParcelDeliveryContract.php b/src/Contracts/ParcelDeliveryContract.php index 28accd448..a7fb73aef 100644 --- a/src/Contracts/ParcelDeliveryContract.php +++ b/src/Contracts/ParcelDeliveryContract.php @@ -4,52 +4,52 @@ interface ParcelDeliveryContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function carrier($carrier); public function deliveryAddress($deliveryAddress); public function deliveryStatus($deliveryStatus); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function expectedArrivalFrom($expectedArrivalFrom); public function expectedArrivalUntil($expectedArrivalUntil); public function hasDeliveryMethod($hasDeliveryMethod); - public function itemShipped($itemShipped); - - public function originAddress($originAddress); - - public function partOfOrder($partOfOrder); - - public function provider($provider); - - public function trackingNumber($trackingNumber); - - public function trackingUrl($trackingUrl); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - public function identifier($identifier); public function image($image); + public function itemShipped($itemShipped); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function originAddress($originAddress); + + public function partOfOrder($partOfOrder); + public function potentialAction($potentialAction); + public function provider($provider); + public function sameAs($sameAs); public function subjectOf($subjectOf); + public function trackingNumber($trackingNumber); + + public function trackingUrl($trackingUrl); + public function url($url); } diff --git a/src/Contracts/ParentAudienceContract.php b/src/Contracts/ParentAudienceContract.php index d121dd053..747841578 100644 --- a/src/Contracts/ParentAudienceContract.php +++ b/src/Contracts/ParentAudienceContract.php @@ -4,34 +4,22 @@ interface ParentAudienceContract { - public function childMaxAge($childMaxAge); - - public function childMinAge($childMinAge); - - public function requiredGender($requiredGender); - - public function requiredMaxAge($requiredMaxAge); - - public function requiredMinAge($requiredMinAge); - - public function suggestedGender($suggestedGender); - - public function suggestedMaxAge($suggestedMaxAge); + public function additionalType($additionalType); - public function suggestedMinAge($suggestedMinAge); + public function alternateName($alternateName); public function audienceType($audienceType); - public function geographicArea($geographicArea); - - public function additionalType($additionalType); + public function childMaxAge($childMaxAge); - public function alternateName($alternateName); + public function childMinAge($childMinAge); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function geographicArea($geographicArea); + public function identifier($identifier); public function image($image); @@ -42,10 +30,22 @@ public function name($name); public function potentialAction($potentialAction); + public function requiredGender($requiredGender); + + public function requiredMaxAge($requiredMaxAge); + + public function requiredMinAge($requiredMinAge); + public function sameAs($sameAs); public function subjectOf($subjectOf); + public function suggestedGender($suggestedGender); + + public function suggestedMaxAge($suggestedMaxAge); + + public function suggestedMinAge($suggestedMinAge); + public function url($url); } diff --git a/src/Contracts/ParkContract.php b/src/Contracts/ParkContract.php index 1ee26bc2d..2aa213d48 100644 --- a/src/Contracts/ParkContract.php +++ b/src/Contracts/ParkContract.php @@ -4,14 +4,16 @@ interface ParkContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ParkingFacilityContract.php b/src/Contracts/ParkingFacilityContract.php index b6813e4c0..17a716a69 100644 --- a/src/Contracts/ParkingFacilityContract.php +++ b/src/Contracts/ParkingFacilityContract.php @@ -4,14 +4,16 @@ interface ParkingFacilityContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/PawnShopContract.php b/src/Contracts/PawnShopContract.php index 83a479c0a..2b5c731b6 100644 --- a/src/Contracts/PawnShopContract.php +++ b/src/Contracts/PawnShopContract.php @@ -4,34 +4,48 @@ interface PawnShopContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/PayActionContract.php b/src/Contracts/PayActionContract.php index 2016c70c8..47b0e523a 100644 --- a/src/Contracts/PayActionContract.php +++ b/src/Contracts/PayActionContract.php @@ -4,58 +4,58 @@ interface PayActionContract { - public function recipient($recipient); + public function actionStatus($actionStatus); - public function price($price); + public function additionalType($additionalType); - public function priceCurrency($priceCurrency); + public function agent($agent); - public function priceSpecification($priceSpecification); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function description($description); - public function agent($agent); + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function price($price); - public function image($image); + public function priceCurrency($priceCurrency); - public function mainEntityOfPage($mainEntityOfPage); + public function priceSpecification($priceSpecification); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/PaymentCardContract.php b/src/Contracts/PaymentCardContract.php index d29e3e590..d08e72a09 100644 --- a/src/Contracts/PaymentCardContract.php +++ b/src/Contracts/PaymentCardContract.php @@ -4,13 +4,13 @@ interface PaymentCardContract { - public function annualPercentageRate($annualPercentageRate); + public function additionalType($additionalType); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function aggregateRating($aggregateRating); - public function interestRate($interestRate); + public function alternateName($alternateName); - public function aggregateRating($aggregateRating); + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -26,18 +26,36 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -46,6 +64,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -56,26 +76,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/PaymentChargeSpecificationContract.php b/src/Contracts/PaymentChargeSpecificationContract.php index f9b0a50a7..5668e886f 100644 --- a/src/Contracts/PaymentChargeSpecificationContract.php +++ b/src/Contracts/PaymentChargeSpecificationContract.php @@ -4,50 +4,50 @@ interface PaymentChargeSpecificationContract { - public function appliesToDeliveryMethod($appliesToDeliveryMethod); - - public function appliesToPaymentMethod($appliesToPaymentMethod); - - public function eligibleQuantity($eligibleQuantity); - - public function eligibleTransactionVolume($eligibleTransactionVolume); - - public function maxPrice($maxPrice); - - public function minPrice($minPrice); - - public function price($price); - - public function priceCurrency($priceCurrency); - - public function validFrom($validFrom); - - public function validThrough($validThrough); - - public function valueAddedTaxIncluded($valueAddedTaxIncluded); - public function additionalType($additionalType); public function alternateName($alternateName); + public function appliesToDeliveryMethod($appliesToDeliveryMethod); + + public function appliesToPaymentMethod($appliesToPaymentMethod); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function eligibleQuantity($eligibleQuantity); + + public function eligibleTransactionVolume($eligibleTransactionVolume); + public function identifier($identifier); public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function maxPrice($maxPrice); + + public function minPrice($minPrice); + public function name($name); public function potentialAction($potentialAction); + public function price($price); + + public function priceCurrency($priceCurrency); + public function sameAs($sameAs); public function subjectOf($subjectOf); public function url($url); + public function validFrom($validFrom); + + public function validThrough($validThrough); + + public function valueAddedTaxIncluded($valueAddedTaxIncluded); + } diff --git a/src/Contracts/PaymentServiceContract.php b/src/Contracts/PaymentServiceContract.php index c45e7f6c6..70709d4bf 100644 --- a/src/Contracts/PaymentServiceContract.php +++ b/src/Contracts/PaymentServiceContract.php @@ -4,13 +4,13 @@ interface PaymentServiceContract { - public function annualPercentageRate($annualPercentageRate); + public function additionalType($additionalType); - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function aggregateRating($aggregateRating); - public function interestRate($interestRate); + public function alternateName($alternateName); - public function aggregateRating($aggregateRating); + public function annualPercentageRate($annualPercentageRate); public function areaServed($areaServed); @@ -26,18 +26,36 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + + public function interestRate($interestRate); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -46,6 +64,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -56,26 +76,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/PeopleAudienceContract.php b/src/Contracts/PeopleAudienceContract.php index 20ee2b608..6ad0d5a5d 100644 --- a/src/Contracts/PeopleAudienceContract.php +++ b/src/Contracts/PeopleAudienceContract.php @@ -4,30 +4,18 @@ interface PeopleAudienceContract { - public function requiredGender($requiredGender); - - public function requiredMaxAge($requiredMaxAge); - - public function requiredMinAge($requiredMinAge); - - public function suggestedGender($suggestedGender); - - public function suggestedMaxAge($suggestedMaxAge); - - public function suggestedMinAge($suggestedMinAge); - - public function audienceType($audienceType); - - public function geographicArea($geographicArea); - public function additionalType($additionalType); public function alternateName($alternateName); + public function audienceType($audienceType); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function geographicArea($geographicArea); + public function identifier($identifier); public function image($image); @@ -38,10 +26,22 @@ public function name($name); public function potentialAction($potentialAction); + public function requiredGender($requiredGender); + + public function requiredMaxAge($requiredMaxAge); + + public function requiredMinAge($requiredMinAge); + public function sameAs($sameAs); public function subjectOf($subjectOf); + public function suggestedGender($suggestedGender); + + public function suggestedMaxAge($suggestedMaxAge); + + public function suggestedMinAge($suggestedMinAge); + public function url($url); } diff --git a/src/Contracts/PerformActionContract.php b/src/Contracts/PerformActionContract.php index 1abc81fcf..8827d6cde 100644 --- a/src/Contracts/PerformActionContract.php +++ b/src/Contracts/PerformActionContract.php @@ -4,56 +4,56 @@ interface PerformActionContract { - public function entertainmentBusiness($entertainmentBusiness); - - public function audience($audience); - - public function event($event); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); + public function additionalType($additionalType); - public function object($object); + public function agent($agent); - public function participant($participant); + public function alternateName($alternateName); - public function result($result); + public function audience($audience); - public function startTime($startTime); + public function description($description); - public function target($target); + public function disambiguatingDescription($disambiguatingDescription); - public function additionalType($additionalType); + public function endTime($endTime); - public function alternateName($alternateName); + public function entertainmentBusiness($entertainmentBusiness); - public function description($description); + public function error($error); - public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/PerformanceRoleContract.php b/src/Contracts/PerformanceRoleContract.php index ce4072d19..b1a3a4cc4 100644 --- a/src/Contracts/PerformanceRoleContract.php +++ b/src/Contracts/PerformanceRoleContract.php @@ -4,24 +4,18 @@ interface PerformanceRoleContract { - public function characterName($characterName); - - public function endDate($endDate); - - public function namedPosition($namedPosition); - - public function roleName($roleName); - - public function startDate($startDate); - public function additionalType($additionalType); public function alternateName($alternateName); + public function characterName($characterName); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endDate($endDate); + public function identifier($identifier); public function image($image); @@ -30,10 +24,16 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function namedPosition($namedPosition); + public function potentialAction($potentialAction); + public function roleName($roleName); + public function sameAs($sameAs); + public function startDate($startDate); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/PerformingArtsTheaterContract.php b/src/Contracts/PerformingArtsTheaterContract.php index c69980610..b637d45ca 100644 --- a/src/Contracts/PerformingArtsTheaterContract.php +++ b/src/Contracts/PerformingArtsTheaterContract.php @@ -4,14 +4,16 @@ interface PerformingArtsTheaterContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/PerformingGroupContract.php b/src/Contracts/PerformingGroupContract.php index 422313620..93f787d0e 100644 --- a/src/Contracts/PerformingGroupContract.php +++ b/src/Contracts/PerformingGroupContract.php @@ -4,10 +4,14 @@ interface PerformingGroupContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/PeriodicalContract.php b/src/Contracts/PeriodicalContract.php index c077ca17b..2ad1b9a30 100644 --- a/src/Contracts/PeriodicalContract.php +++ b/src/Contracts/PeriodicalContract.php @@ -4,12 +4,6 @@ interface PeriodicalContract { - public function endDate($endDate); - - public function issn($issn); - - public function startDate($startDate); - public function about($about); public function accessMode($accessMode); @@ -28,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -70,6 +68,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -84,6 +88,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -98,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -114,6 +124,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -124,14 +136,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -160,6 +180,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -174,36 +198,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function director($director); - } diff --git a/src/Contracts/PermitContract.php b/src/Contracts/PermitContract.php index 7a5b2bcd9..e4f218597 100644 --- a/src/Contracts/PermitContract.php +++ b/src/Contracts/PermitContract.php @@ -4,20 +4,6 @@ interface PermitContract { - public function issuedBy($issuedBy); - - public function issuedThrough($issuedThrough); - - public function permitAudience($permitAudience); - - public function validFor($validFor); - - public function validFrom($validFrom); - - public function validIn($validIn); - - public function validUntil($validUntil); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -30,10 +16,16 @@ public function identifier($identifier); public function image($image); + public function issuedBy($issuedBy); + + public function issuedThrough($issuedThrough); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function permitAudience($permitAudience); + public function potentialAction($potentialAction); public function sameAs($sameAs); @@ -42,4 +34,12 @@ public function subjectOf($subjectOf); public function url($url); + public function validFor($validFor); + + public function validFrom($validFrom); + + public function validIn($validIn); + + public function validUntil($validUntil); + } diff --git a/src/Contracts/PersonContract.php b/src/Contracts/PersonContract.php index 385087806..4537b0c87 100644 --- a/src/Contracts/PersonContract.php +++ b/src/Contracts/PersonContract.php @@ -6,10 +6,14 @@ interface PersonContract { public function additionalName($additionalName); + public function additionalType($additionalType); + public function address($address); public function affiliation($affiliation); + public function alternateName($alternateName); + public function alumniOf($alumniOf); public function award($award); @@ -36,6 +40,10 @@ public function deathDate($deathDate); public function deathPlace($deathPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function duns($duns); public function email($email); @@ -68,18 +76,26 @@ public function honorificPrefix($honorificPrefix); public function honorificSuffix($honorificSuffix); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function jobTitle($jobTitle); public function knows($knows); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function memberOf($memberOf); public function naics($naics); + public function name($name); + public function nationality($nationality); public function netWorth($netWorth); @@ -92,10 +108,14 @@ public function parents($parents); public function performerIn($performerIn); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function relatedTo($relatedTo); + public function sameAs($sameAs); + public function seeks($seeks); public function sibling($sibling); @@ -106,10 +126,14 @@ public function sponsor($sponsor); public function spouse($spouse); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); + public function url($url); + public function vatID($vatID); public function weight($weight); @@ -118,28 +142,4 @@ public function workLocation($workLocation); public function worksFor($worksFor); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/PetStoreContract.php b/src/Contracts/PetStoreContract.php index 1bf3220df..4d7dc9013 100644 --- a/src/Contracts/PetStoreContract.php +++ b/src/Contracts/PetStoreContract.php @@ -4,34 +4,48 @@ interface PetStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/PharmacyContract.php b/src/Contracts/PharmacyContract.php index c336033e8..cfa940e24 100644 --- a/src/Contracts/PharmacyContract.php +++ b/src/Contracts/PharmacyContract.php @@ -4,10 +4,14 @@ interface PharmacyContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/PhotographActionContract.php b/src/Contracts/PhotographActionContract.php index 824c35e79..c8d564de3 100644 --- a/src/Contracts/PhotographActionContract.php +++ b/src/Contracts/PhotographActionContract.php @@ -6,48 +6,48 @@ interface PhotographActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/PhotographContract.php b/src/Contracts/PhotographContract.php index 4035fd51c..4ae5621f9 100644 --- a/src/Contracts/PhotographContract.php +++ b/src/Contracts/PhotographContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/PhysicianContract.php b/src/Contracts/PhysicianContract.php index 20dece8e9..1fd1e0295 100644 --- a/src/Contracts/PhysicianContract.php +++ b/src/Contracts/PhysicianContract.php @@ -4,10 +4,14 @@ interface PhysicianContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/PlaceContract.php b/src/Contracts/PlaceContract.php index 110bcc7c6..3b776606c 100644 --- a/src/Contracts/PlaceContract.php +++ b/src/Contracts/PlaceContract.php @@ -6,10 +6,14 @@ interface PlaceContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/PlaceOfWorshipContract.php b/src/Contracts/PlaceOfWorshipContract.php index 55085862c..232a6d149 100644 --- a/src/Contracts/PlaceOfWorshipContract.php +++ b/src/Contracts/PlaceOfWorshipContract.php @@ -4,14 +4,16 @@ interface PlaceOfWorshipContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/PlanActionContract.php b/src/Contracts/PlanActionContract.php index 9ea2a5277..b16412428 100644 --- a/src/Contracts/PlanActionContract.php +++ b/src/Contracts/PlanActionContract.php @@ -4,52 +4,52 @@ interface PlanActionContract { - public function scheduledTime($scheduledTime); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function scheduledTime($scheduledTime); + + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/PlayActionContract.php b/src/Contracts/PlayActionContract.php index 08b63fba1..612a15e4c 100644 --- a/src/Contracts/PlayActionContract.php +++ b/src/Contracts/PlayActionContract.php @@ -4,54 +4,54 @@ interface PlayActionContract { - public function audience($audience); - - public function event($event); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function additionalType($additionalType); - public function participant($participant); + public function agent($agent); - public function result($result); + public function alternateName($alternateName); - public function startTime($startTime); + public function audience($audience); - public function target($target); + public function description($description); - public function additionalType($additionalType); + public function disambiguatingDescription($disambiguatingDescription); - public function alternateName($alternateName); + public function endTime($endTime); - public function description($description); + public function error($error); - public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/PlaygroundContract.php b/src/Contracts/PlaygroundContract.php index 09d9a2c9e..2a91021a5 100644 --- a/src/Contracts/PlaygroundContract.php +++ b/src/Contracts/PlaygroundContract.php @@ -4,14 +4,16 @@ interface PlaygroundContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/PlumberContract.php b/src/Contracts/PlumberContract.php index b9fa5772f..3e2872bdc 100644 --- a/src/Contracts/PlumberContract.php +++ b/src/Contracts/PlumberContract.php @@ -4,34 +4,48 @@ interface PlumberContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/PoliceStationContract.php b/src/Contracts/PoliceStationContract.php index 64441608c..697582fda 100644 --- a/src/Contracts/PoliceStationContract.php +++ b/src/Contracts/PoliceStationContract.php @@ -4,178 +4,178 @@ interface PoliceStationContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); - public function branchCode($branchCode); + public function areaServed($areaServed); - public function containedIn($containedIn); + public function award($award); - public function containedInPlace($containedInPlace); + public function awards($awards); - public function containsPlace($containsPlace); + public function branchCode($branchCode); - public function event($event); + public function branchOf($branchOf); - public function events($events); + public function brand($brand); - public function faxNumber($faxNumber); + public function contactPoint($contactPoint); - public function geo($geo); + public function contactPoints($contactPoints); - public function globalLocationNumber($globalLocationNumber); + public function containedIn($containedIn); - public function hasMap($hasMap); + public function containedInPlace($containedInPlace); - public function isAccessibleForFree($isAccessibleForFree); + public function containsPlace($containsPlace); - public function isicV4($isicV4); + public function currenciesAccepted($currenciesAccepted); - public function latitude($latitude); + public function department($department); - public function logo($logo); + public function description($description); - public function longitude($longitude); + public function disambiguatingDescription($disambiguatingDescription); - public function map($map); + public function dissolutionDate($dissolutionDate); - public function maps($maps); + public function duns($duns); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function email($email); - public function openingHoursSpecification($openingHoursSpecification); + public function employee($employee); - public function photo($photo); + public function employees($employees); - public function photos($photos); + public function event($event); - public function publicAccess($publicAccess); + public function events($events); - public function review($review); + public function faxNumber($faxNumber); - public function reviews($reviews); + public function founder($founder); - public function slogan($slogan); + public function founders($founders); - public function smokingAllowed($smokingAllowed); + public function foundingDate($foundingDate); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function foundingLocation($foundingLocation); - public function telephone($telephone); + public function funder($funder); - public function additionalType($additionalType); + public function geo($geo); - public function alternateName($alternateName); + public function globalLocationNumber($globalLocationNumber); - public function description($description); + public function hasMap($hasMap); - public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); + + public function hasPOS($hasPOS); public function identifier($identifier); public function image($image); - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); + public function isAccessibleForFree($isAccessibleForFree); - public function branchOf($branchOf); + public function isicV4($isicV4); - public function currenciesAccepted($currenciesAccepted); + public function latitude($latitude); - public function paymentAccepted($paymentAccepted); + public function legalName($legalName); - public function priceRange($priceRange); + public function leiCode($leiCode); - public function areaServed($areaServed); + public function location($location); - public function award($award); + public function logo($logo); - public function awards($awards); + public function longitude($longitude); - public function brand($brand); + public function mainEntityOfPage($mainEntityOfPage); - public function contactPoint($contactPoint); + public function makesOffer($makesOffer); - public function contactPoints($contactPoints); + public function map($map); - public function department($department); + public function maps($maps); - public function dissolutionDate($dissolutionDate); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function duns($duns); + public function member($member); - public function email($email); + public function memberOf($memberOf); - public function employee($employee); + public function members($members); - public function employees($employees); + public function naics($naics); - public function founder($founder); + public function name($name); - public function founders($founders); + public function numberOfEmployees($numberOfEmployees); - public function foundingDate($foundingDate); + public function offeredBy($offeredBy); - public function foundingLocation($foundingLocation); + public function openingHours($openingHours); - public function funder($funder); + public function openingHoursSpecification($openingHoursSpecification); - public function hasOfferCatalog($hasOfferCatalog); + public function owns($owns); - public function hasPOS($hasPOS); + public function parentOrganization($parentOrganization); - public function legalName($legalName); + public function paymentAccepted($paymentAccepted); - public function leiCode($leiCode); + public function photo($photo); - public function location($location); + public function photos($photos); - public function makesOffer($makesOffer); + public function potentialAction($potentialAction); - public function member($member); + public function priceRange($priceRange); - public function memberOf($memberOf); + public function publicAccess($publicAccess); - public function members($members); + public function publishingPrinciples($publishingPrinciples); - public function naics($naics); + public function review($review); - public function numberOfEmployees($numberOfEmployees); + public function reviews($reviews); - public function offeredBy($offeredBy); + public function sameAs($sameAs); - public function owns($owns); + public function seeks($seeks); - public function parentOrganization($parentOrganization); + public function serviceArea($serviceArea); - public function publishingPrinciples($publishingPrinciples); + public function slogan($slogan); - public function seeks($seeks); + public function smokingAllowed($smokingAllowed); - public function serviceArea($serviceArea); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); + public function telephone($telephone); + + public function url($url); + public function vatID($vatID); } diff --git a/src/Contracts/PondContract.php b/src/Contracts/PondContract.php index 70a5ae77a..824bfece8 100644 --- a/src/Contracts/PondContract.php +++ b/src/Contracts/PondContract.php @@ -6,10 +6,14 @@ interface PondContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/PostOfficeContract.php b/src/Contracts/PostOfficeContract.php index 66625e24a..02bf1b8e3 100644 --- a/src/Contracts/PostOfficeContract.php +++ b/src/Contracts/PostOfficeContract.php @@ -4,34 +4,48 @@ interface PostOfficeContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/PostalAddressContract.php b/src/Contracts/PostalAddressContract.php index 5488a0b36..fc7cef840 100644 --- a/src/Contracts/PostalAddressContract.php +++ b/src/Contracts/PostalAddressContract.php @@ -4,17 +4,15 @@ interface PostalAddressContract { + public function additionalType($additionalType); + public function addressCountry($addressCountry); public function addressLocality($addressLocality); public function addressRegion($addressRegion); - public function postOfficeBoxNumber($postOfficeBoxNumber); - - public function postalCode($postalCode); - - public function streetAddress($streetAddress); + public function alternateName($alternateName); public function areaServed($areaServed); @@ -24,26 +22,16 @@ public function contactOption($contactOption); public function contactType($contactType); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function email($email); public function faxNumber($faxNumber); public function hoursAvailable($hoursAvailable); - public function productSupported($productSupported); - - public function serviceArea($serviceArea); - - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - public function identifier($identifier); public function image($image); @@ -52,12 +40,24 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function postOfficeBoxNumber($postOfficeBoxNumber); + + public function postalCode($postalCode); + public function potentialAction($potentialAction); + public function productSupported($productSupported); + public function sameAs($sameAs); + public function serviceArea($serviceArea); + + public function streetAddress($streetAddress); + public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/PreOrderActionContract.php b/src/Contracts/PreOrderActionContract.php index 5ac8b5b3d..dec80234b 100644 --- a/src/Contracts/PreOrderActionContract.php +++ b/src/Contracts/PreOrderActionContract.php @@ -4,56 +4,56 @@ interface PreOrderActionContract { - public function price($price); - - public function priceCurrency($priceCurrency); - - public function priceSpecification($priceSpecification); - public function actionStatus($actionStatus); + public function additionalType($additionalType); + public function agent($agent); - public function endTime($endTime); + public function alternateName($alternateName); - public function error($error); + public function description($description); - public function instrument($instrument); + public function disambiguatingDescription($disambiguatingDescription); - public function location($location); + public function endTime($endTime); - public function object($object); + public function error($error); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function location($location); - public function additionalType($additionalType); + public function mainEntityOfPage($mainEntityOfPage); - public function alternateName($alternateName); + public function name($name); - public function description($description); + public function object($object); - public function disambiguatingDescription($disambiguatingDescription); + public function participant($participant); - public function identifier($identifier); + public function potentialAction($potentialAction); - public function image($image); + public function price($price); - public function mainEntityOfPage($mainEntityOfPage); + public function priceCurrency($priceCurrency); - public function name($name); + public function priceSpecification($priceSpecification); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/PrependActionContract.php b/src/Contracts/PrependActionContract.php index 9e0e497f0..12705c193 100644 --- a/src/Contracts/PrependActionContract.php +++ b/src/Contracts/PrependActionContract.php @@ -4,55 +4,55 @@ interface PrependActionContract { - public function toLocation($toLocation); + public function actionStatus($actionStatus); - public function collection($collection); + public function additionalType($additionalType); - public function targetCollection($targetCollection); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function collection($collection); - public function endTime($endTime); + public function description($description); - public function error($error); + public function disambiguatingDescription($disambiguatingDescription); - public function instrument($instrument); + public function endTime($endTime); - public function location($location); + public function error($error); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function result($result); - public function image($image); + public function sameAs($sameAs); - public function mainEntityOfPage($mainEntityOfPage); + public function startTime($startTime); - public function name($name); + public function subjectOf($subjectOf); - public function potentialAction($potentialAction); + public function target($target); - public function sameAs($sameAs); + public function targetCollection($targetCollection); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/PreschoolContract.php b/src/Contracts/PreschoolContract.php index 55b6295d3..3e96c2b91 100644 --- a/src/Contracts/PreschoolContract.php +++ b/src/Contracts/PreschoolContract.php @@ -4,12 +4,16 @@ interface PreschoolContract { - public function alumni($alumni); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function alumni($alumni); + public function areaServed($areaServed); public function award($award); @@ -24,6 +28,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +64,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +78,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +90,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +100,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -100,34 +120,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/PresentationDigitalDocumentContract.php b/src/Contracts/PresentationDigitalDocumentContract.php index 8bbb9c00e..e1e18f640 100644 --- a/src/Contracts/PresentationDigitalDocumentContract.php +++ b/src/Contracts/PresentationDigitalDocumentContract.php @@ -4,8 +4,6 @@ interface PresentationDigitalDocumentContract { - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); - public function about($about); public function accessMode($accessMode); @@ -24,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -66,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -90,10 +96,16 @@ public function funder($funder); public function genre($genre); + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); + public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -120,14 +132,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -156,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,34 +192,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/PriceSpecificationContract.php b/src/Contracts/PriceSpecificationContract.php index c46cca872..b96bb131d 100644 --- a/src/Contracts/PriceSpecificationContract.php +++ b/src/Contracts/PriceSpecificationContract.php @@ -4,24 +4,6 @@ interface PriceSpecificationContract { - public function eligibleQuantity($eligibleQuantity); - - public function eligibleTransactionVolume($eligibleTransactionVolume); - - public function maxPrice($maxPrice); - - public function minPrice($minPrice); - - public function price($price); - - public function priceCurrency($priceCurrency); - - public function validFrom($validFrom); - - public function validThrough($validThrough); - - public function valueAddedTaxIncluded($valueAddedTaxIncluded); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -30,20 +12,38 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function eligibleQuantity($eligibleQuantity); + + public function eligibleTransactionVolume($eligibleTransactionVolume); + public function identifier($identifier); public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function maxPrice($maxPrice); + + public function minPrice($minPrice); + public function name($name); public function potentialAction($potentialAction); + public function price($price); + + public function priceCurrency($priceCurrency); + public function sameAs($sameAs); public function subjectOf($subjectOf); public function url($url); + public function validFrom($validFrom); + + public function validThrough($validThrough); + + public function valueAddedTaxIncluded($valueAddedTaxIncluded); + } diff --git a/src/Contracts/ProductContract.php b/src/Contracts/ProductContract.php index 36d362e32..3c4a35276 100644 --- a/src/Contracts/ProductContract.php +++ b/src/Contracts/ProductContract.php @@ -6,8 +6,12 @@ interface ProductContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function audience($audience); public function award($award); @@ -22,6 +26,10 @@ public function color($color); public function depth($depth); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function gtin12($gtin12); public function gtin13($gtin13); @@ -32,6 +40,10 @@ public function gtin8($gtin8); public function height($height); + public function identifier($identifier); + + public function image($image); + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor); public function isConsumableFor($isConsumableFor); @@ -44,6 +56,8 @@ public function itemCondition($itemCondition); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function manufacturer($manufacturer); public function material($material); @@ -52,8 +66,12 @@ public function model($model); public function mpn($mpn); + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function productID($productID); public function productionDate($productionDate); @@ -66,36 +84,18 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function sku($sku); public function slogan($slogan); - public function weight($weight); - - public function width($width); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); + public function weight($weight); + + public function width($width); + } diff --git a/src/Contracts/ProductModelContract.php b/src/Contracts/ProductModelContract.php index 902fc8362..f5d33fec4 100644 --- a/src/Contracts/ProductModelContract.php +++ b/src/Contracts/ProductModelContract.php @@ -4,16 +4,14 @@ interface ProductModelContract { - public function isVariantOf($isVariantOf); - - public function predecessorOf($predecessorOf); - - public function successorOf($successorOf); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function audience($audience); public function award($award); @@ -28,6 +26,10 @@ public function color($color); public function depth($depth); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function gtin12($gtin12); public function gtin13($gtin13); @@ -38,6 +40,10 @@ public function gtin8($gtin8); public function height($height); + public function identifier($identifier); + + public function image($image); + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor); public function isConsumableFor($isConsumableFor); @@ -46,10 +52,14 @@ public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); + public function isVariantOf($isVariantOf); + public function itemCondition($itemCondition); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function manufacturer($manufacturer); public function material($material); @@ -58,8 +68,14 @@ public function model($model); public function mpn($mpn); + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + + public function predecessorOf($predecessorOf); + public function productID($productID); public function productionDate($productionDate); @@ -72,36 +88,20 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function sku($sku); public function slogan($slogan); - public function weight($weight); - - public function width($width); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); + public function subjectOf($subjectOf); - public function potentialAction($potentialAction); + public function successorOf($successorOf); - public function sameAs($sameAs); + public function url($url); - public function subjectOf($subjectOf); + public function weight($weight); - public function url($url); + public function width($width); } diff --git a/src/Contracts/ProfessionalServiceContract.php b/src/Contracts/ProfessionalServiceContract.php index 3464dd310..568f40116 100644 --- a/src/Contracts/ProfessionalServiceContract.php +++ b/src/Contracts/ProfessionalServiceContract.php @@ -4,34 +4,48 @@ interface ProfessionalServiceContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ProfilePageContract.php b/src/Contracts/ProfilePageContract.php index f08a46c00..af372661c 100644 --- a/src/Contracts/ProfilePageContract.php +++ b/src/Contracts/ProfilePageContract.php @@ -4,26 +4,6 @@ interface ProfilePageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ProgramMembershipContract.php b/src/Contracts/ProgramMembershipContract.php index 4a27cebd9..9d8d0ee9f 100644 --- a/src/Contracts/ProgramMembershipContract.php +++ b/src/Contracts/ProgramMembershipContract.php @@ -4,16 +4,6 @@ interface ProgramMembershipContract { - public function hostingOrganization($hostingOrganization); - - public function member($member); - - public function members($members); - - public function membershipNumber($membershipNumber); - - public function programName($programName); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -22,16 +12,26 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function hostingOrganization($hostingOrganization); + public function identifier($identifier); public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function member($member); + + public function members($members); + + public function membershipNumber($membershipNumber); + public function name($name); public function potentialAction($potentialAction); + public function programName($programName); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/PropertyValueContract.php b/src/Contracts/PropertyValueContract.php index 01a2a3e2d..f9a37c57d 100644 --- a/src/Contracts/PropertyValueContract.php +++ b/src/Contracts/PropertyValueContract.php @@ -4,20 +4,6 @@ interface PropertyValueContract { - public function maxValue($maxValue); - - public function minValue($minValue); - - public function propertyID($propertyID); - - public function unitCode($unitCode); - - public function unitText($unitText); - - public function value($value); - - public function valueReference($valueReference); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -32,14 +18,28 @@ public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function maxValue($maxValue); + + public function minValue($minValue); + public function name($name); public function potentialAction($potentialAction); + public function propertyID($propertyID); + public function sameAs($sameAs); public function subjectOf($subjectOf); + public function unitCode($unitCode); + + public function unitText($unitText); + public function url($url); + public function value($value); + + public function valueReference($valueReference); + } diff --git a/src/Contracts/PropertyValueSpecificationContract.php b/src/Contracts/PropertyValueSpecificationContract.php index ddeddb856..a44f3e6b1 100644 --- a/src/Contracts/PropertyValueSpecificationContract.php +++ b/src/Contracts/PropertyValueSpecificationContract.php @@ -4,32 +4,12 @@ interface PropertyValueSpecificationContract { - public function defaultValue($defaultValue); - - public function maxValue($maxValue); - - public function minValue($minValue); - - public function multipleValues($multipleValues); - - public function readonlyValue($readonlyValue); - - public function stepValue($stepValue); - - public function valueMaxLength($valueMaxLength); - - public function valueMinLength($valueMinLength); - - public function valueName($valueName); - - public function valuePattern($valuePattern); - - public function valueRequired($valueRequired); - public function additionalType($additionalType); public function alternateName($alternateName); + public function defaultValue($defaultValue); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -40,14 +20,34 @@ public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function maxValue($maxValue); + + public function minValue($minValue); + + public function multipleValues($multipleValues); + public function name($name); public function potentialAction($potentialAction); + public function readonlyValue($readonlyValue); + public function sameAs($sameAs); + public function stepValue($stepValue); + public function subjectOf($subjectOf); public function url($url); + public function valueMaxLength($valueMaxLength); + + public function valueMinLength($valueMinLength); + + public function valueName($valueName); + + public function valuePattern($valuePattern); + + public function valueRequired($valueRequired); + } diff --git a/src/Contracts/PublicSwimmingPoolContract.php b/src/Contracts/PublicSwimmingPoolContract.php index 3934286f0..ee43916c9 100644 --- a/src/Contracts/PublicSwimmingPoolContract.php +++ b/src/Contracts/PublicSwimmingPoolContract.php @@ -4,34 +4,48 @@ interface PublicSwimmingPoolContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/PublicationEventContract.php b/src/Contracts/PublicationEventContract.php index 8b7688a89..9ea1c3792 100644 --- a/src/Contracts/PublicationEventContract.php +++ b/src/Contracts/PublicationEventContract.php @@ -4,18 +4,16 @@ interface PublicationEventContract { - public function free($free); - - public function isAccessibleForFree($isAccessibleForFree); - - public function publishedOn($publishedOn); - public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -26,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -36,16 +38,26 @@ public function endDate($endDate); public function eventStatus($eventStatus); + public function free($free); + public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -54,14 +66,20 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); + public function publishedOn($publishedOn); + public function recordedIn($recordedIn); public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -70,38 +88,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/PublicationIssueContract.php b/src/Contracts/PublicationIssueContract.php index bcd36418d..46ffa6b1e 100644 --- a/src/Contracts/PublicationIssueContract.php +++ b/src/Contracts/PublicationIssueContract.php @@ -4,14 +4,6 @@ interface PublicationIssueContract { - public function issueNumber($issueNumber); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - public function about($about); public function accessMode($accessMode); @@ -30,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -72,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -100,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -116,6 +120,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issueNumber($issueNumber); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -126,14 +132,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -152,6 +170,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -162,6 +182,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -176,34 +198,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/PublicationVolumeContract.php b/src/Contracts/PublicationVolumeContract.php index 417833d6a..7cacf714b 100644 --- a/src/Contracts/PublicationVolumeContract.php +++ b/src/Contracts/PublicationVolumeContract.php @@ -4,14 +4,6 @@ interface PublicationVolumeContract { - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function volumeNumber($volumeNumber); - public function about($about); public function accessMode($accessMode); @@ -30,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -72,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -100,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -126,14 +130,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -152,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -162,6 +180,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -176,34 +196,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function volumeNumber($volumeNumber); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/QAPageContract.php b/src/Contracts/QAPageContract.php index bce834021..8e86a8288 100644 --- a/src/Contracts/QAPageContract.php +++ b/src/Contracts/QAPageContract.php @@ -4,26 +4,6 @@ interface QAPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/QualitativeValueContract.php b/src/Contracts/QualitativeValueContract.php index 7902237c1..4d879c5dc 100644 --- a/src/Contracts/QualitativeValueContract.php +++ b/src/Contracts/QualitativeValueContract.php @@ -6,20 +6,6 @@ interface QualitativeValueContract { public function additionalProperty($additionalProperty); - public function equal($equal); - - public function greater($greater); - - public function greaterOrEqual($greaterOrEqual); - - public function lesser($lesser); - - public function lesserOrEqual($lesserOrEqual); - - public function nonEqual($nonEqual); - - public function valueReference($valueReference); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -28,14 +14,26 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function equal($equal); + + public function greater($greater); + + public function greaterOrEqual($greaterOrEqual); + public function identifier($identifier); public function image($image); + public function lesser($lesser); + + public function lesserOrEqual($lesserOrEqual); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function nonEqual($nonEqual); + public function potentialAction($potentialAction); public function sameAs($sameAs); @@ -44,4 +42,6 @@ public function subjectOf($subjectOf); public function url($url); + public function valueReference($valueReference); + } diff --git a/src/Contracts/QuantitativeValueContract.php b/src/Contracts/QuantitativeValueContract.php index 592ffa21a..dfacde615 100644 --- a/src/Contracts/QuantitativeValueContract.php +++ b/src/Contracts/QuantitativeValueContract.php @@ -6,18 +6,6 @@ interface QuantitativeValueContract { public function additionalProperty($additionalProperty); - public function maxValue($maxValue); - - public function minValue($minValue); - - public function unitCode($unitCode); - - public function unitText($unitText); - - public function value($value); - - public function valueReference($valueReference); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -32,6 +20,10 @@ public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function maxValue($maxValue); + + public function minValue($minValue); + public function name($name); public function potentialAction($potentialAction); @@ -40,6 +32,14 @@ public function sameAs($sameAs); public function subjectOf($subjectOf); + public function unitCode($unitCode); + + public function unitText($unitText); + public function url($url); + public function value($value); + + public function valueReference($valueReference); + } diff --git a/src/Contracts/QuantitativeValueDistributionContract.php b/src/Contracts/QuantitativeValueDistributionContract.php index dce8d2c55..74d3a36cc 100644 --- a/src/Contracts/QuantitativeValueDistributionContract.php +++ b/src/Contracts/QuantitativeValueDistributionContract.php @@ -4,16 +4,6 @@ interface QuantitativeValueDistributionContract { - public function median($median); - - public function percentile10($percentile10); - - public function percentile25($percentile25); - - public function percentile75($percentile75); - - public function percentile90($percentile90); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -28,8 +18,18 @@ public function image($image); public function mainEntityOfPage($mainEntityOfPage); + public function median($median); + public function name($name); + public function percentile10($percentile10); + + public function percentile25($percentile25); + + public function percentile75($percentile75); + + public function percentile90($percentile90); + public function potentialAction($potentialAction); public function sameAs($sameAs); diff --git a/src/Contracts/QuestionContract.php b/src/Contracts/QuestionContract.php index 8a05dd68d..daa6c3112 100644 --- a/src/Contracts/QuestionContract.php +++ b/src/Contracts/QuestionContract.php @@ -4,18 +4,10 @@ interface QuestionContract { - public function acceptedAnswer($acceptedAnswer); - - public function answerCount($answerCount); - - public function downvoteCount($downvoteCount); - - public function suggestedAnswer($suggestedAnswer); - - public function upvoteCount($upvoteCount); - public function about($about); + public function acceptedAnswer($acceptedAnswer); + public function accessMode($accessMode); public function accessModeSufficient($accessModeSufficient); @@ -32,10 +24,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function answerCount($answerCount); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -74,8 +72,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function downvoteCount($downvoteCount); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -102,6 +106,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -128,14 +136,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -154,6 +168,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -164,6 +180,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + + public function suggestedAnswer($suggestedAnswer); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -178,34 +198,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function upvoteCount($upvoteCount); + + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/QuoteActionContract.php b/src/Contracts/QuoteActionContract.php index 63d735b4f..5181efe39 100644 --- a/src/Contracts/QuoteActionContract.php +++ b/src/Contracts/QuoteActionContract.php @@ -4,56 +4,56 @@ interface QuoteActionContract { - public function price($price); - - public function priceCurrency($priceCurrency); - - public function priceSpecification($priceSpecification); - public function actionStatus($actionStatus); + public function additionalType($additionalType); + public function agent($agent); - public function endTime($endTime); + public function alternateName($alternateName); - public function error($error); + public function description($description); - public function instrument($instrument); + public function disambiguatingDescription($disambiguatingDescription); - public function location($location); + public function endTime($endTime); - public function object($object); + public function error($error); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function location($location); - public function additionalType($additionalType); + public function mainEntityOfPage($mainEntityOfPage); - public function alternateName($alternateName); + public function name($name); - public function description($description); + public function object($object); - public function disambiguatingDescription($disambiguatingDescription); + public function participant($participant); - public function identifier($identifier); + public function potentialAction($potentialAction); - public function image($image); + public function price($price); - public function mainEntityOfPage($mainEntityOfPage); + public function priceCurrency($priceCurrency); - public function name($name); + public function priceSpecification($priceSpecification); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/RVParkContract.php b/src/Contracts/RVParkContract.php index 7b0402592..be645e01b 100644 --- a/src/Contracts/RVParkContract.php +++ b/src/Contracts/RVParkContract.php @@ -4,14 +4,16 @@ interface RVParkContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/RadioChannelContract.php b/src/Contracts/RadioChannelContract.php index 6cd1539d1..2f4e1b60b 100644 --- a/src/Contracts/RadioChannelContract.php +++ b/src/Contracts/RadioChannelContract.php @@ -4,36 +4,36 @@ interface RadioChannelContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function broadcastChannelId($broadcastChannelId); public function broadcastFrequency($broadcastFrequency); public function broadcastServiceTier($broadcastServiceTier); - public function genre($genre); - - public function inBroadcastLineup($inBroadcastLineup); - - public function providesBroadcastService($providesBroadcastService); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function genre($genre); + public function identifier($identifier); public function image($image); + public function inBroadcastLineup($inBroadcastLineup); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function providesBroadcastService($providesBroadcastService); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/RadioClipContract.php b/src/Contracts/RadioClipContract.php index bc984165f..e4c28f980 100644 --- a/src/Contracts/RadioClipContract.php +++ b/src/Contracts/RadioClipContract.php @@ -4,24 +4,6 @@ interface RadioClipContract { - public function actor($actor); - - public function actors($actors); - - public function clipNumber($clipNumber); - - public function director($director); - - public function directors($directors); - - public function musicBy($musicBy); - - public function partOfEpisode($partOfEpisode); - - public function partOfSeason($partOfSeason); - - public function partOfSeries($partOfSeries); - public function about($about); public function accessMode($accessMode); @@ -40,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -60,6 +50,8 @@ public function character($character); public function citation($citation); + public function clipNumber($clipNumber); + public function comment($comment); public function commentCount($commentCount); @@ -82,6 +74,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -110,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,14 +140,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function partOfEpisode($partOfEpisode); + + public function partOfSeason($partOfSeason); + + public function partOfSeries($partOfSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -162,6 +180,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -172,6 +192,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -186,34 +208,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/RadioEpisodeContract.php b/src/Contracts/RadioEpisodeContract.php index fada6cf8c..90d3d0fef 100644 --- a/src/Contracts/RadioEpisodeContract.php +++ b/src/Contracts/RadioEpisodeContract.php @@ -4,26 +4,6 @@ interface RadioEpisodeContract { - public function actor($actor); - - public function actors($actors); - - public function director($director); - - public function directors($directors); - - public function episodeNumber($episodeNumber); - - public function musicBy($musicBy); - - public function partOfSeason($partOfSeason); - - public function partOfSeries($partOfSeries); - - public function productionCompany($productionCompany); - - public function trailer($trailer); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -84,6 +72,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -98,6 +94,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function episodeNumber($episodeNumber); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -112,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -138,16 +140,30 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function partOfSeason($partOfSeason); + + public function partOfSeries($partOfSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -164,6 +180,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -174,6 +192,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -184,38 +204,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/RadioSeasonContract.php b/src/Contracts/RadioSeasonContract.php index 36ee5fb32..7e8736393 100644 --- a/src/Contracts/RadioSeasonContract.php +++ b/src/Contracts/RadioSeasonContract.php @@ -4,28 +4,6 @@ interface RadioSeasonContract { - public function actor($actor); - - public function director($director); - - public function endDate($endDate); - - public function episode($episode); - - public function episodes($episodes); - - public function numberOfEpisodes($numberOfEpisodes); - - public function partOfSeries($partOfSeries); - - public function productionCompany($productionCompany); - - public function seasonNumber($seasonNumber); - - public function startDate($startDate); - - public function trailer($trailer); - public function about($about); public function accessMode($accessMode); @@ -44,8 +22,14 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -86,6 +70,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -100,6 +90,12 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + + public function episode($episode); + + public function episodes($episodes); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -114,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -140,16 +140,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function numberOfEpisodes($numberOfEpisodes); + public function offers($offers); + public function partOfSeries($partOfSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -166,8 +178,12 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function seasonNumber($seasonNumber); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -176,6 +192,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -186,38 +206,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/RadioSeriesContract.php b/src/Contracts/RadioSeriesContract.php index 035048145..1e537daad 100644 --- a/src/Contracts/RadioSeriesContract.php +++ b/src/Contracts/RadioSeriesContract.php @@ -4,40 +4,6 @@ interface RadioSeriesContract { - public function actor($actor); - - public function actors($actors); - - public function containsSeason($containsSeason); - - public function director($director); - - public function directors($directors); - - public function episode($episode); - - public function episodes($episodes); - - public function musicBy($musicBy); - - public function numberOfEpisodes($numberOfEpisodes); - - public function numberOfSeasons($numberOfSeasons); - - public function productionCompany($productionCompany); - - public function season($season); - - public function seasons($seasons); - - public function trailer($trailer); - - public function endDate($endDate); - - public function issn($issn); - - public function startDate($startDate); - public function about($about); public function accessMode($accessMode); @@ -56,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -80,6 +54,8 @@ public function comment($comment); public function commentCount($commentCount); + public function containsSeason($containsSeason); + public function contentLocation($contentLocation); public function contentRating($contentRating); @@ -98,6 +74,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +96,12 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + + public function episode($episode); + + public function episodes($episodes); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -126,6 +116,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -142,6 +136,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -152,16 +148,30 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + + public function numberOfEpisodes($numberOfEpisodes); + + public function numberOfSeasons($numberOfSeasons); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -178,8 +188,14 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function season($season); + + public function seasons($seasons); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -188,6 +204,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -198,40 +218,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function director($director); - } diff --git a/src/Contracts/RadioStationContract.php b/src/Contracts/RadioStationContract.php index 2b235012f..151164fa5 100644 --- a/src/Contracts/RadioStationContract.php +++ b/src/Contracts/RadioStationContract.php @@ -4,34 +4,48 @@ interface RadioStationContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/RatingContract.php b/src/Contracts/RatingContract.php index 63f3bc3d5..1647ba6f0 100644 --- a/src/Contracts/RatingContract.php +++ b/src/Contracts/RatingContract.php @@ -4,20 +4,14 @@ interface RatingContract { - public function author($author); - - public function bestRating($bestRating); - - public function ratingValue($ratingValue); - - public function reviewAspect($reviewAspect); - - public function worstRating($worstRating); - public function additionalType($additionalType); public function alternateName($alternateName); + public function author($author); + + public function bestRating($bestRating); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -32,10 +26,16 @@ public function name($name); public function potentialAction($potentialAction); + public function ratingValue($ratingValue); + + public function reviewAspect($reviewAspect); + public function sameAs($sameAs); public function subjectOf($subjectOf); public function url($url); + public function worstRating($worstRating); + } diff --git a/src/Contracts/ReactActionContract.php b/src/Contracts/ReactActionContract.php index 86f680ccd..10da1896b 100644 --- a/src/Contracts/ReactActionContract.php +++ b/src/Contracts/ReactActionContract.php @@ -6,48 +6,48 @@ interface ReactActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ReadActionContract.php b/src/Contracts/ReadActionContract.php index f1c6040a7..8409eba63 100644 --- a/src/Contracts/ReadActionContract.php +++ b/src/Contracts/ReadActionContract.php @@ -6,52 +6,52 @@ interface ReadActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/RealEstateAgentContract.php b/src/Contracts/RealEstateAgentContract.php index 0d8fbf91b..08c6b4cfe 100644 --- a/src/Contracts/RealEstateAgentContract.php +++ b/src/Contracts/RealEstateAgentContract.php @@ -4,34 +4,48 @@ interface RealEstateAgentContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ReceiveActionContract.php b/src/Contracts/ReceiveActionContract.php index 2479663d7..071cc8c41 100644 --- a/src/Contracts/ReceiveActionContract.php +++ b/src/Contracts/ReceiveActionContract.php @@ -4,57 +4,57 @@ interface ReceiveActionContract { - public function deliveryMethod($deliveryMethod); + public function actionStatus($actionStatus); - public function sender($sender); + public function additionalType($additionalType); - public function fromLocation($fromLocation); + public function agent($agent); - public function toLocation($toLocation); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function deliveryMethod($deliveryMethod); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); + public function fromLocation($fromLocation); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function result($result); - public function image($image); + public function sameAs($sameAs); - public function mainEntityOfPage($mainEntityOfPage); + public function sender($sender); - public function name($name); + public function startTime($startTime); - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function target($target); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/RecipeContract.php b/src/Contracts/RecipeContract.php index f05f06b6d..968e4b98d 100644 --- a/src/Contracts/RecipeContract.php +++ b/src/Contracts/RecipeContract.php @@ -4,44 +4,6 @@ interface RecipeContract { - public function cookTime($cookTime); - - public function cookingMethod($cookingMethod); - - public function ingredients($ingredients); - - public function nutrition($nutrition); - - public function recipeCategory($recipeCategory); - - public function recipeCuisine($recipeCuisine); - - public function recipeIngredient($recipeIngredient); - - public function recipeInstructions($recipeInstructions); - - public function recipeYield($recipeYield); - - public function suitableForDiet($suitableForDiet); - - public function estimatedCost($estimatedCost); - - public function performTime($performTime); - - public function prepTime($prepTime); - - public function step($step); - - public function steps($steps); - - public function supply($supply); - - public function tool($tool); - - public function totalTime($totalTime); - - public function yield($yield); - public function about($about); public function accessMode($accessMode); @@ -60,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -90,6 +56,10 @@ public function contentRating($contentRating); public function contributor($contributor); + public function cookTime($cookTime); + + public function cookingMethod($cookingMethod); + public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); @@ -102,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -116,6 +90,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function estimatedCost($estimatedCost); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -130,8 +106,14 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function ingredients($ingredients); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -156,14 +138,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function nutrition($nutrition); + public function offers($offers); + public function performTime($performTime); + public function position($position); + public function potentialAction($potentialAction); + + public function prepTime($prepTime); + public function producer($producer); public function provider($provider); @@ -174,6 +168,16 @@ public function publisher($publisher); public function publishingPrinciples($publishingPrinciples); + public function recipeCategory($recipeCategory); + + public function recipeCuisine($recipeCuisine); + + public function recipeIngredient($recipeIngredient); + + public function recipeInstructions($recipeInstructions); + + public function recipeYield($recipeYield); + public function recordedAt($recordedAt); public function releasedEvent($releasedEvent); @@ -182,6 +186,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -192,6 +198,16 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function step($step); + + public function steps($steps); + + public function subjectOf($subjectOf); + + public function suitableForDiet($suitableForDiet); + + public function supply($supply); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -202,38 +218,22 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function tool($tool); + + public function totalTime($totalTime); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); + public function yield($yield); } diff --git a/src/Contracts/RecyclingCenterContract.php b/src/Contracts/RecyclingCenterContract.php index 725fe8885..b54df867a 100644 --- a/src/Contracts/RecyclingCenterContract.php +++ b/src/Contracts/RecyclingCenterContract.php @@ -4,34 +4,48 @@ interface RecyclingCenterContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/RegisterActionContract.php b/src/Contracts/RegisterActionContract.php index 8f130f5e9..7d65b7915 100644 --- a/src/Contracts/RegisterActionContract.php +++ b/src/Contracts/RegisterActionContract.php @@ -6,48 +6,48 @@ interface RegisterActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/RejectActionContract.php b/src/Contracts/RejectActionContract.php index e1e2b112a..4c2eac708 100644 --- a/src/Contracts/RejectActionContract.php +++ b/src/Contracts/RejectActionContract.php @@ -6,48 +6,48 @@ interface RejectActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/RentActionContract.php b/src/Contracts/RentActionContract.php index 32e0de0c6..3a61525fa 100644 --- a/src/Contracts/RentActionContract.php +++ b/src/Contracts/RentActionContract.php @@ -4,60 +4,60 @@ interface RentActionContract { - public function landlord($landlord); - - public function realEstateAgent($realEstateAgent); + public function actionStatus($actionStatus); - public function price($price); + public function additionalType($additionalType); - public function priceCurrency($priceCurrency); + public function agent($agent); - public function priceSpecification($priceSpecification); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function description($description); - public function agent($agent); + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); + public function identifier($identifier); - public function object($object); + public function image($image); - public function participant($participant); + public function instrument($instrument); - public function result($result); + public function landlord($landlord); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function price($price); - public function image($image); + public function priceCurrency($priceCurrency); - public function mainEntityOfPage($mainEntityOfPage); + public function priceSpecification($priceSpecification); - public function name($name); + public function realEstateAgent($realEstateAgent); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/RentalCarReservationContract.php b/src/Contracts/RentalCarReservationContract.php index 16d507d8d..a34fcf7bc 100644 --- a/src/Contracts/RentalCarReservationContract.php +++ b/src/Contracts/RentalCarReservationContract.php @@ -4,13 +4,9 @@ interface RentalCarReservationContract { - public function dropoffLocation($dropoffLocation); - - public function dropoffTime($dropoffTime); - - public function pickupLocation($pickupLocation); + public function additionalType($additionalType); - public function pickupTime($pickupTime); + public function alternateName($alternateName); public function bookingAgent($bookingAgent); @@ -18,48 +14,52 @@ public function bookingTime($bookingTime); public function broker($broker); - public function modifiedTime($modifiedTime); + public function description($description); - public function priceCurrency($priceCurrency); + public function disambiguatingDescription($disambiguatingDescription); - public function programMembershipUsed($programMembershipUsed); + public function dropoffLocation($dropoffLocation); - public function provider($provider); + public function dropoffTime($dropoffTime); - public function reservationFor($reservationFor); + public function identifier($identifier); - public function reservationId($reservationId); + public function image($image); - public function reservationStatus($reservationStatus); + public function mainEntityOfPage($mainEntityOfPage); - public function reservedTicket($reservedTicket); + public function modifiedTime($modifiedTime); - public function totalPrice($totalPrice); + public function name($name); - public function underName($underName); + public function pickupLocation($pickupLocation); - public function additionalType($additionalType); + public function pickupTime($pickupTime); - public function alternateName($alternateName); + public function potentialAction($potentialAction); - public function description($description); + public function priceCurrency($priceCurrency); - public function disambiguatingDescription($disambiguatingDescription); + public function programMembershipUsed($programMembershipUsed); - public function identifier($identifier); + public function provider($provider); - public function image($image); + public function reservationFor($reservationFor); - public function mainEntityOfPage($mainEntityOfPage); + public function reservationId($reservationId); - public function name($name); + public function reservationStatus($reservationStatus); - public function potentialAction($potentialAction); + public function reservedTicket($reservedTicket); public function sameAs($sameAs); public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/ReplaceActionContract.php b/src/Contracts/ReplaceActionContract.php index b04665d79..3b2cb2c3a 100644 --- a/src/Contracts/ReplaceActionContract.php +++ b/src/Contracts/ReplaceActionContract.php @@ -4,57 +4,57 @@ interface ReplaceActionContract { - public function replacee($replacee); + public function actionStatus($actionStatus); - public function replacer($replacer); + public function additionalType($additionalType); - public function collection($collection); + public function agent($agent); - public function targetCollection($targetCollection); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function collection($collection); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); + public function identifier($identifier); - public function object($object); + public function image($image); - public function participant($participant); + public function instrument($instrument); - public function result($result); + public function location($location); - public function startTime($startTime); + public function mainEntityOfPage($mainEntityOfPage); - public function target($target); + public function name($name); - public function additionalType($additionalType); + public function object($object); - public function alternateName($alternateName); + public function participant($participant); - public function description($description); + public function potentialAction($potentialAction); - public function disambiguatingDescription($disambiguatingDescription); + public function replacee($replacee); - public function identifier($identifier); + public function replacer($replacer); - public function image($image); + public function result($result); - public function mainEntityOfPage($mainEntityOfPage); + public function sameAs($sameAs); - public function name($name); + public function startTime($startTime); - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function target($target); - public function subjectOf($subjectOf); + public function targetCollection($targetCollection); public function url($url); diff --git a/src/Contracts/ReplyActionContract.php b/src/Contracts/ReplyActionContract.php index 3e422579e..acef91b7e 100644 --- a/src/Contracts/ReplyActionContract.php +++ b/src/Contracts/ReplyActionContract.php @@ -4,60 +4,60 @@ interface ReplyActionContract { - public function resultComment($resultComment); - public function about($about); - public function inLanguage($inLanguage); + public function actionStatus($actionStatus); - public function language($language); + public function additionalType($additionalType); - public function recipient($recipient); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function inLanguage($inLanguage); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function language($language); - public function additionalType($additionalType); + public function location($location); - public function alternateName($alternateName); + public function mainEntityOfPage($mainEntityOfPage); - public function description($description); + public function name($name); - public function disambiguatingDescription($disambiguatingDescription); + public function object($object); - public function identifier($identifier); + public function participant($participant); - public function image($image); + public function potentialAction($potentialAction); - public function mainEntityOfPage($mainEntityOfPage); + public function recipient($recipient); - public function name($name); + public function result($result); - public function potentialAction($potentialAction); + public function resultComment($resultComment); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ReportContract.php b/src/Contracts/ReportContract.php index 6c00fffbb..6d88487d9 100644 --- a/src/Contracts/ReportContract.php +++ b/src/Contracts/ReportContract.php @@ -4,22 +4,6 @@ interface ReportContract { - public function reportNumber($reportNumber); - - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -38,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -80,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -108,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -134,14 +134,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -156,10 +168,14 @@ public function recordedAt($recordedAt); public function releasedEvent($releasedEvent); + public function reportNumber($reportNumber); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -168,8 +184,12 @@ public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -184,34 +204,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/ReservationContract.php b/src/Contracts/ReservationContract.php index 804fc5732..ff9acb791 100644 --- a/src/Contracts/ReservationContract.php +++ b/src/Contracts/ReservationContract.php @@ -4,14 +4,32 @@ interface ReservationContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function bookingAgent($bookingAgent); public function bookingTime($bookingTime); public function broker($broker); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function identifier($identifier); + + public function image($image); + + public function mainEntityOfPage($mainEntityOfPage); + public function modifiedTime($modifiedTime); + public function name($name); + + public function potentialAction($potentialAction); + public function priceCurrency($priceCurrency); public function programMembershipUsed($programMembershipUsed); @@ -26,32 +44,14 @@ public function reservationStatus($reservationStatus); public function reservedTicket($reservedTicket); - public function totalPrice($totalPrice); - - public function underName($underName); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - public function sameAs($sameAs); public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/ReservationPackageContract.php b/src/Contracts/ReservationPackageContract.php index 5e8f42517..72994906f 100644 --- a/src/Contracts/ReservationPackageContract.php +++ b/src/Contracts/ReservationPackageContract.php @@ -4,9 +4,11 @@ interface ReservationPackageContract { - public function boardingGroup($boardingGroup); + public function additionalType($additionalType); - public function subReservation($subReservation); + public function alternateName($alternateName); + + public function boardingGroup($boardingGroup); public function bookingAgent($bookingAgent); @@ -14,8 +16,22 @@ public function bookingTime($bookingTime); public function broker($broker); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function identifier($identifier); + + public function image($image); + + public function mainEntityOfPage($mainEntityOfPage); + public function modifiedTime($modifiedTime); + public function name($name); + + public function potentialAction($potentialAction); + public function priceCurrency($priceCurrency); public function programMembershipUsed($programMembershipUsed); @@ -30,31 +46,15 @@ public function reservationStatus($reservationStatus); public function reservedTicket($reservedTicket); - public function totalPrice($totalPrice); - - public function underName($underName); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); + public function sameAs($sameAs); - public function name($name); + public function subReservation($subReservation); - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function totalPrice($totalPrice); - public function subjectOf($subjectOf); + public function underName($underName); public function url($url); diff --git a/src/Contracts/ReserveActionContract.php b/src/Contracts/ReserveActionContract.php index 8cef31676..2ea21931b 100644 --- a/src/Contracts/ReserveActionContract.php +++ b/src/Contracts/ReserveActionContract.php @@ -4,52 +4,52 @@ interface ReserveActionContract { - public function scheduledTime($scheduledTime); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function scheduledTime($scheduledTime); + + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ReservoirContract.php b/src/Contracts/ReservoirContract.php index 073f013b0..0a280e330 100644 --- a/src/Contracts/ReservoirContract.php +++ b/src/Contracts/ReservoirContract.php @@ -6,10 +6,14 @@ interface ReservoirContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ResidenceContract.php b/src/Contracts/ResidenceContract.php index 33b6e1b33..ee82976ad 100644 --- a/src/Contracts/ResidenceContract.php +++ b/src/Contracts/ResidenceContract.php @@ -6,10 +6,14 @@ interface ResidenceContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/ResortContract.php b/src/Contracts/ResortContract.php index 06fefb5db..ab5254b96 100644 --- a/src/Contracts/ResortContract.php +++ b/src/Contracts/ResortContract.php @@ -4,50 +4,56 @@ interface ResortContract { - public function amenityFeature($amenityFeature); + public function additionalProperty($additionalProperty); - public function audience($audience); + public function additionalType($additionalType); - public function availableLanguage($availableLanguage); + public function address($address); - public function checkinTime($checkinTime); + public function aggregateRating($aggregateRating); - public function checkoutTime($checkoutTime); + public function alternateName($alternateName); - public function numberOfRooms($numberOfRooms); + public function amenityFeature($amenityFeature); - public function petsAllowed($petsAllowed); + public function areaServed($areaServed); - public function starRating($starRating); + public function audience($audience); - public function branchOf($branchOf); + public function availableLanguage($availableLanguage); - public function currenciesAccepted($currenciesAccepted); + public function award($award); - public function openingHours($openingHours); + public function awards($awards); - public function paymentAccepted($paymentAccepted); + public function branchCode($branchCode); - public function priceRange($priceRange); + public function branchOf($branchOf); - public function address($address); + public function brand($brand); - public function aggregateRating($aggregateRating); + public function checkinTime($checkinTime); - public function areaServed($areaServed); + public function checkoutTime($checkoutTime); - public function award($award); + public function contactPoint($contactPoint); - public function awards($awards); + public function contactPoints($contactPoints); - public function brand($brand); + public function containedIn($containedIn); - public function contactPoint($contactPoint); + public function containedInPlace($containedInPlace); - public function contactPoints($contactPoints); + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -74,14 +80,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -90,106 +108,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); + public function longitude($longitude); - public function owns($owns); + public function mainEntityOfPage($mainEntityOfPage); - public function parentOrganization($parentOrganization); + public function makesOffer($makesOffer); - public function publishingPrinciples($publishingPrinciples); + public function map($map); - public function review($review); + public function maps($maps); - public function reviews($reviews); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function seeks($seeks); + public function member($member); - public function serviceArea($serviceArea); + public function memberOf($memberOf); - public function slogan($slogan); + public function members($members); - public function sponsor($sponsor); + public function naics($naics); - public function subOrganization($subOrganization); + public function name($name); - public function taxID($taxID); + public function numberOfEmployees($numberOfEmployees); - public function telephone($telephone); + public function numberOfRooms($numberOfRooms); - public function vatID($vatID); + public function offeredBy($offeredBy); - public function additionalType($additionalType); + public function openingHours($openingHours); - public function alternateName($alternateName); + public function openingHoursSpecification($openingHoursSpecification); - public function description($description); + public function owns($owns); - public function disambiguatingDescription($disambiguatingDescription); + public function parentOrganization($parentOrganization); - public function identifier($identifier); + public function paymentAccepted($paymentAccepted); - public function image($image); + public function petsAllowed($petsAllowed); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function branchCode($branchCode); + public function publicAccess($publicAccess); - public function containedIn($containedIn); + public function publishingPrinciples($publishingPrinciples); - public function containedInPlace($containedInPlace); + public function review($review); - public function containsPlace($containsPlace); + public function reviews($reviews); - public function geo($geo); + public function sameAs($sameAs); - public function hasMap($hasMap); + public function seeks($seeks); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/RestaurantContract.php b/src/Contracts/RestaurantContract.php index 60ae8b481..642145b52 100644 --- a/src/Contracts/RestaurantContract.php +++ b/src/Contracts/RestaurantContract.php @@ -6,42 +6,48 @@ interface RestaurantContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ResumeActionContract.php b/src/Contracts/ResumeActionContract.php index 19f003494..e4dcafca9 100644 --- a/src/Contracts/ResumeActionContract.php +++ b/src/Contracts/ResumeActionContract.php @@ -6,48 +6,48 @@ interface ResumeActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ReturnActionContract.php b/src/Contracts/ReturnActionContract.php index b8f0de886..85844dff5 100644 --- a/src/Contracts/ReturnActionContract.php +++ b/src/Contracts/ReturnActionContract.php @@ -4,55 +4,55 @@ interface ReturnActionContract { - public function recipient($recipient); + public function actionStatus($actionStatus); - public function fromLocation($fromLocation); + public function additionalType($additionalType); - public function toLocation($toLocation); + public function agent($agent); - public function actionStatus($actionStatus); + public function alternateName($alternateName); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); + public function fromLocation($fromLocation); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function recipient($recipient); - public function image($image); + public function result($result); - public function mainEntityOfPage($mainEntityOfPage); + public function sameAs($sameAs); - public function name($name); + public function startTime($startTime); - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function target($target); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/ReviewActionContract.php b/src/Contracts/ReviewActionContract.php index f3bc0552d..468c38b62 100644 --- a/src/Contracts/ReviewActionContract.php +++ b/src/Contracts/ReviewActionContract.php @@ -4,52 +4,52 @@ interface ReviewActionContract { - public function resultReview($resultReview); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + + public function resultReview($resultReview); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ReviewContract.php b/src/Contracts/ReviewContract.php index 2766dd85b..90198b8ec 100644 --- a/src/Contracts/ReviewContract.php +++ b/src/Contracts/ReviewContract.php @@ -4,14 +4,6 @@ interface ReviewContract { - public function itemReviewed($itemReviewed); - - public function reviewAspect($reviewAspect); - - public function reviewBody($reviewBody); - - public function reviewRating($reviewRating); - public function about($about); public function accessMode($accessMode); @@ -30,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -72,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -100,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -116,6 +120,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function itemReviewed($itemReviewed); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -126,14 +132,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -150,8 +162,16 @@ public function releasedEvent($releasedEvent); public function review($review); + public function reviewAspect($reviewAspect); + + public function reviewBody($reviewBody); + + public function reviewRating($reviewRating); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -162,6 +182,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -176,34 +198,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/RiverBodyOfWaterContract.php b/src/Contracts/RiverBodyOfWaterContract.php index de492e0c6..c4dea0626 100644 --- a/src/Contracts/RiverBodyOfWaterContract.php +++ b/src/Contracts/RiverBodyOfWaterContract.php @@ -6,10 +6,14 @@ interface RiverBodyOfWaterContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/RoleContract.php b/src/Contracts/RoleContract.php index 69042b8e0..4ce66114e 100644 --- a/src/Contracts/RoleContract.php +++ b/src/Contracts/RoleContract.php @@ -4,14 +4,6 @@ interface RoleContract { - public function endDate($endDate); - - public function namedPosition($namedPosition); - - public function roleName($roleName); - - public function startDate($startDate); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -20,6 +12,8 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endDate($endDate); + public function identifier($identifier); public function image($image); @@ -28,10 +22,16 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function namedPosition($namedPosition); + public function potentialAction($potentialAction); + public function roleName($roleName); + public function sameAs($sameAs); + public function startDate($startDate); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/RoofingContractorContract.php b/src/Contracts/RoofingContractorContract.php index d5cd163f4..37a58f33b 100644 --- a/src/Contracts/RoofingContractorContract.php +++ b/src/Contracts/RoofingContractorContract.php @@ -4,34 +4,48 @@ interface RoofingContractorContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/RoomContract.php b/src/Contracts/RoomContract.php index 89f540d97..de5458bdb 100644 --- a/src/Contracts/RoomContract.php +++ b/src/Contracts/RoomContract.php @@ -4,22 +4,18 @@ interface RoomContract { - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); - - public function numberOfRooms($numberOfRooms); - - public function permittedUsage($permittedUsage); - - public function petsAllowed($petsAllowed); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function branchCode($branchCode); public function containedIn($containedIn); @@ -28,18 +24,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -50,54 +56,48 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/RsvpActionContract.php b/src/Contracts/RsvpActionContract.php index 5a90dcf61..a647fc9f4 100644 --- a/src/Contracts/RsvpActionContract.php +++ b/src/Contracts/RsvpActionContract.php @@ -4,66 +4,66 @@ interface RsvpActionContract { - public function additionalNumberOfGuests($additionalNumberOfGuests); - - public function comment($comment); + public function about($about); - public function rsvpResponse($rsvpResponse); + public function actionStatus($actionStatus); - public function event($event); + public function additionalNumberOfGuests($additionalNumberOfGuests); - public function about($about); + public function additionalType($additionalType); - public function inLanguage($inLanguage); + public function agent($agent); - public function language($language); + public function alternateName($alternateName); - public function recipient($recipient); + public function comment($comment); - public function actionStatus($actionStatus); + public function description($description); - public function agent($agent); + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); + public function event($event); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function inLanguage($inLanguage); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function language($language); - public function additionalType($additionalType); + public function location($location); - public function alternateName($alternateName); + public function mainEntityOfPage($mainEntityOfPage); - public function description($description); + public function name($name); - public function disambiguatingDescription($disambiguatingDescription); + public function object($object); - public function identifier($identifier); + public function participant($participant); - public function image($image); + public function potentialAction($potentialAction); - public function mainEntityOfPage($mainEntityOfPage); + public function recipient($recipient); - public function name($name); + public function result($result); - public function potentialAction($potentialAction); + public function rsvpResponse($rsvpResponse); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/SaleEventContract.php b/src/Contracts/SaleEventContract.php index 5d607c383..2f3e609be 100644 --- a/src/Contracts/SaleEventContract.php +++ b/src/Contracts/SaleEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/ScheduleActionContract.php b/src/Contracts/ScheduleActionContract.php index 0a4125cd5..056d07952 100644 --- a/src/Contracts/ScheduleActionContract.php +++ b/src/Contracts/ScheduleActionContract.php @@ -4,52 +4,52 @@ interface ScheduleActionContract { - public function scheduledTime($scheduledTime); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function scheduledTime($scheduledTime); + + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ScholarlyArticleContract.php b/src/Contracts/ScholarlyArticleContract.php index fb3d36d05..a90969700 100644 --- a/src/Contracts/ScholarlyArticleContract.php +++ b/src/Contracts/ScholarlyArticleContract.php @@ -4,20 +4,6 @@ interface ScholarlyArticleContract { - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -36,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -78,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -106,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -132,14 +134,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -158,6 +172,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -166,8 +182,12 @@ public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -182,34 +202,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/SchoolContract.php b/src/Contracts/SchoolContract.php index 6d250007f..573697faa 100644 --- a/src/Contracts/SchoolContract.php +++ b/src/Contracts/SchoolContract.php @@ -4,12 +4,16 @@ interface SchoolContract { - public function alumni($alumni); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function alumni($alumni); + public function areaServed($areaServed); public function award($award); @@ -24,6 +28,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +64,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +78,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +90,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +100,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -100,34 +120,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/ScreeningEventContract.php b/src/Contracts/ScreeningEventContract.php index a1ba6cc76..2fe480e24 100644 --- a/src/Contracts/ScreeningEventContract.php +++ b/src/Contracts/ScreeningEventContract.php @@ -4,18 +4,16 @@ interface ScreeningEventContract { - public function subtitleLanguage($subtitleLanguage); - - public function videoFormat($videoFormat); - - public function workPresented($workPresented); - public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -26,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -38,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -54,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -62,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -70,38 +84,24 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + + public function subtitleLanguage($subtitleLanguage); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function workFeatured($workFeatured); - - public function workPerformed($workPerformed); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); + public function url($url); - public function potentialAction($potentialAction); + public function videoFormat($videoFormat); - public function sameAs($sameAs); + public function workFeatured($workFeatured); - public function subjectOf($subjectOf); + public function workPerformed($workPerformed); - public function url($url); + public function workPresented($workPresented); } diff --git a/src/Contracts/SculptureContract.php b/src/Contracts/SculptureContract.php index 941754d34..6603eba06 100644 --- a/src/Contracts/SculptureContract.php +++ b/src/Contracts/SculptureContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/SeaBodyOfWaterContract.php b/src/Contracts/SeaBodyOfWaterContract.php index d111a2cc1..88ffb70af 100644 --- a/src/Contracts/SeaBodyOfWaterContract.php +++ b/src/Contracts/SeaBodyOfWaterContract.php @@ -6,10 +6,14 @@ interface SeaBodyOfWaterContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/SearchActionContract.php b/src/Contracts/SearchActionContract.php index e5ef68ca8..581a63b07 100644 --- a/src/Contracts/SearchActionContract.php +++ b/src/Contracts/SearchActionContract.php @@ -4,52 +4,52 @@ interface SearchActionContract { - public function query($query); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function query($query); + + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/SearchResultsPageContract.php b/src/Contracts/SearchResultsPageContract.php index 73e1d1a59..7decf0ad1 100644 --- a/src/Contracts/SearchResultsPageContract.php +++ b/src/Contracts/SearchResultsPageContract.php @@ -4,26 +4,6 @@ interface SearchResultsPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/SeasonContract.php b/src/Contracts/SeasonContract.php index bdb68ca69..5e73d6bb3 100644 --- a/src/Contracts/SeasonContract.php +++ b/src/Contracts/SeasonContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/SeatContract.php b/src/Contracts/SeatContract.php index e628181b1..8e1c94129 100644 --- a/src/Contracts/SeatContract.php +++ b/src/Contracts/SeatContract.php @@ -4,14 +4,6 @@ interface SeatContract { - public function seatNumber($seatNumber); - - public function seatRow($seatRow); - - public function seatSection($seatSection); - - public function seatingType($seatingType); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -32,6 +24,14 @@ public function potentialAction($potentialAction); public function sameAs($sameAs); + public function seatNumber($seatNumber); + + public function seatRow($seatRow); + + public function seatSection($seatSection); + + public function seatingType($seatingType); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/SelfStorageContract.php b/src/Contracts/SelfStorageContract.php index 9c268462d..07c08f345 100644 --- a/src/Contracts/SelfStorageContract.php +++ b/src/Contracts/SelfStorageContract.php @@ -4,34 +4,48 @@ interface SelfStorageContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/SellActionContract.php b/src/Contracts/SellActionContract.php index 2c4d68d56..10b74ef2e 100644 --- a/src/Contracts/SellActionContract.php +++ b/src/Contracts/SellActionContract.php @@ -4,60 +4,60 @@ interface SellActionContract { - public function buyer($buyer); + public function actionStatus($actionStatus); - public function warrantyPromise($warrantyPromise); + public function additionalType($additionalType); - public function price($price); + public function agent($agent); - public function priceCurrency($priceCurrency); + public function alternateName($alternateName); - public function priceSpecification($priceSpecification); + public function buyer($buyer); - public function actionStatus($actionStatus); + public function description($description); - public function agent($agent); + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function location($location); - public function additionalType($additionalType); + public function mainEntityOfPage($mainEntityOfPage); - public function alternateName($alternateName); + public function name($name); - public function description($description); + public function object($object); - public function disambiguatingDescription($disambiguatingDescription); + public function participant($participant); - public function identifier($identifier); + public function potentialAction($potentialAction); - public function image($image); + public function price($price); - public function mainEntityOfPage($mainEntityOfPage); + public function priceCurrency($priceCurrency); - public function name($name); + public function priceSpecification($priceSpecification); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); + public function warrantyPromise($warrantyPromise); + } diff --git a/src/Contracts/SendActionContract.php b/src/Contracts/SendActionContract.php index 2f451e051..8df5b556c 100644 --- a/src/Contracts/SendActionContract.php +++ b/src/Contracts/SendActionContract.php @@ -4,57 +4,57 @@ interface SendActionContract { - public function deliveryMethod($deliveryMethod); + public function actionStatus($actionStatus); - public function recipient($recipient); + public function additionalType($additionalType); - public function fromLocation($fromLocation); + public function agent($agent); - public function toLocation($toLocation); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function deliveryMethod($deliveryMethod); - public function agent($agent); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); + public function fromLocation($fromLocation); - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function recipient($recipient); - public function image($image); + public function result($result); - public function mainEntityOfPage($mainEntityOfPage); + public function sameAs($sameAs); - public function name($name); + public function startTime($startTime); - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function target($target); - public function subjectOf($subjectOf); + public function toLocation($toLocation); public function url($url); diff --git a/src/Contracts/SeriesContract.php b/src/Contracts/SeriesContract.php index 28ccd1bd2..1c1c37046 100644 --- a/src/Contracts/SeriesContract.php +++ b/src/Contracts/SeriesContract.php @@ -4,14 +4,14 @@ interface SeriesContract { - public function director($director); - public function additionalType($additionalType); public function alternateName($alternateName); public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); public function identifier($identifier); diff --git a/src/Contracts/ServiceChannelContract.php b/src/Contracts/ServiceChannelContract.php index cc13ed630..1b0c384e6 100644 --- a/src/Contracts/ServiceChannelContract.php +++ b/src/Contracts/ServiceChannelContract.php @@ -4,26 +4,12 @@ interface ServiceChannelContract { - public function availableLanguage($availableLanguage); - - public function processingTime($processingTime); - - public function providesService($providesService); - - public function serviceLocation($serviceLocation); - - public function servicePhone($servicePhone); - - public function servicePostalAddress($servicePostalAddress); - - public function serviceSmsNumber($serviceSmsNumber); - - public function serviceUrl($serviceUrl); - public function additionalType($additionalType); public function alternateName($alternateName); + public function availableLanguage($availableLanguage); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -38,8 +24,22 @@ public function name($name); public function potentialAction($potentialAction); + public function processingTime($processingTime); + + public function providesService($providesService); + public function sameAs($sameAs); + public function serviceLocation($serviceLocation); + + public function servicePhone($servicePhone); + + public function servicePostalAddress($servicePostalAddress); + + public function serviceSmsNumber($serviceSmsNumber); + + public function serviceUrl($serviceUrl); + public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/ServiceContract.php b/src/Contracts/ServiceContract.php index 5e87d3c07..f67c529e4 100644 --- a/src/Contracts/ServiceContract.php +++ b/src/Contracts/ServiceContract.php @@ -4,8 +4,12 @@ interface ServiceContract { + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function audience($audience); @@ -20,18 +24,32 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -40,6 +58,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -50,26 +70,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/ShareActionContract.php b/src/Contracts/ShareActionContract.php index 9fea03c2b..6694a8dab 100644 --- a/src/Contracts/ShareActionContract.php +++ b/src/Contracts/ShareActionContract.php @@ -6,56 +6,56 @@ interface ShareActionContract { public function about($about); - public function inLanguage($inLanguage); - - public function language($language); - - public function recipient($recipient); - public function actionStatus($actionStatus); + public function additionalType($additionalType); + public function agent($agent); - public function endTime($endTime); + public function alternateName($alternateName); - public function error($error); + public function description($description); - public function instrument($instrument); + public function disambiguatingDescription($disambiguatingDescription); - public function location($location); + public function endTime($endTime); - public function object($object); + public function error($error); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function inLanguage($inLanguage); - public function target($target); + public function instrument($instrument); - public function additionalType($additionalType); + public function language($language); - public function alternateName($alternateName); + public function location($location); - public function description($description); + public function mainEntityOfPage($mainEntityOfPage); - public function disambiguatingDescription($disambiguatingDescription); + public function name($name); - public function identifier($identifier); + public function object($object); - public function image($image); + public function participant($participant); - public function mainEntityOfPage($mainEntityOfPage); + public function potentialAction($potentialAction); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ShoeStoreContract.php b/src/Contracts/ShoeStoreContract.php index 8f02a0bee..8aa4c19fc 100644 --- a/src/Contracts/ShoeStoreContract.php +++ b/src/Contracts/ShoeStoreContract.php @@ -4,34 +4,48 @@ interface ShoeStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ShoppingCenterContract.php b/src/Contracts/ShoppingCenterContract.php index dc41d62da..e91aff578 100644 --- a/src/Contracts/ShoppingCenterContract.php +++ b/src/Contracts/ShoppingCenterContract.php @@ -4,34 +4,48 @@ interface ShoppingCenterContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/SingleFamilyResidenceContract.php b/src/Contracts/SingleFamilyResidenceContract.php index 118cd96ed..55a5e9456 100644 --- a/src/Contracts/SingleFamilyResidenceContract.php +++ b/src/Contracts/SingleFamilyResidenceContract.php @@ -4,26 +4,18 @@ interface SingleFamilyResidenceContract { - public function numberOfRooms($numberOfRooms); - - public function occupancy($occupancy); - - public function numberOfRooms($numberOfRooms); - - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); - - public function permittedUsage($permittedUsage); - - public function petsAllowed($petsAllowed); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function branchCode($branchCode); public function containedIn($containedIn); @@ -32,18 +24,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -54,54 +56,50 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + + public function occupancy($occupancy); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/SiteNavigationElementContract.php b/src/Contracts/SiteNavigationElementContract.php index 76487ea27..2a7efb638 100644 --- a/src/Contracts/SiteNavigationElementContract.php +++ b/src/Contracts/SiteNavigationElementContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/SkiResortContract.php b/src/Contracts/SkiResortContract.php index 5d32dcb37..805fdf29c 100644 --- a/src/Contracts/SkiResortContract.php +++ b/src/Contracts/SkiResortContract.php @@ -4,34 +4,48 @@ interface SkiResortContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/SocialEventContract.php b/src/Contracts/SocialEventContract.php index cfb516597..77d9d9e3c 100644 --- a/src/Contracts/SocialEventContract.php +++ b/src/Contracts/SocialEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/SocialMediaPostingContract.php b/src/Contracts/SocialMediaPostingContract.php index 158edb914..705fd5421 100644 --- a/src/Contracts/SocialMediaPostingContract.php +++ b/src/Contracts/SocialMediaPostingContract.php @@ -4,22 +4,6 @@ interface SocialMediaPostingContract { - public function sharedContent($sharedContent); - - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -38,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -80,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -108,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -134,14 +134,26 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -160,16 +172,24 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function sharedContent($sharedContent); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -184,34 +204,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/SoftwareApplicationContract.php b/src/Contracts/SoftwareApplicationContract.php index be798f615..a6c102d66 100644 --- a/src/Contracts/SoftwareApplicationContract.php +++ b/src/Contracts/SoftwareApplicationContract.php @@ -4,54 +4,6 @@ interface SoftwareApplicationContract { - public function applicationCategory($applicationCategory); - - public function applicationSubCategory($applicationSubCategory); - - public function applicationSuite($applicationSuite); - - public function availableOnDevice($availableOnDevice); - - public function countriesNotSupported($countriesNotSupported); - - public function countriesSupported($countriesSupported); - - public function device($device); - - public function downloadUrl($downloadUrl); - - public function featureList($featureList); - - public function fileSize($fileSize); - - public function installUrl($installUrl); - - public function memoryRequirements($memoryRequirements); - - public function operatingSystem($operatingSystem); - - public function permissions($permissions); - - public function processorRequirements($processorRequirements); - - public function releaseNotes($releaseNotes); - - public function requirements($requirements); - - public function screenshot($screenshot); - - public function softwareAddOn($softwareAddOn); - - public function softwareHelp($softwareHelp); - - public function softwareRequirements($softwareRequirements); - - public function softwareVersion($softwareVersion); - - public function storageRequirements($storageRequirements); - - public function supportingData($supportingData); - public function about($about); public function accessMode($accessMode); @@ -70,10 +22,20 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function applicationCategory($applicationCategory); + + public function applicationSubCategory($applicationSubCategory); + + public function applicationSuite($applicationSuite); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -82,6 +44,8 @@ public function audio($audio); public function author($author); + public function availableOnDevice($availableOnDevice); + public function award($award); public function awards($awards); @@ -104,6 +68,10 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function countriesNotSupported($countriesNotSupported); + + public function countriesSupported($countriesSupported); + public function creator($creator); public function dateCreated($dateCreated); @@ -112,8 +80,16 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function device($device); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function downloadUrl($downloadUrl); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -130,8 +106,12 @@ public function exampleOfWork($exampleOfWork); public function expires($expires); + public function featureList($featureList); + public function fileFormat($fileFormat); + public function fileSize($fileSize); + public function funder($funder); public function genre($genre); @@ -140,8 +120,14 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function installUrl($installUrl); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -166,14 +152,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); + public function memoryRequirements($memoryRequirements); + public function mentions($mentions); + public function name($name); + public function offers($offers); + public function operatingSystem($operatingSystem); + + public function permissions($permissions); + public function position($position); + public function potentialAction($potentialAction); + + public function processorRequirements($processorRequirements); + public function producer($producer); public function provider($provider); @@ -186,14 +186,30 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function releaseNotes($releaseNotes); + public function releasedEvent($releasedEvent); + public function requirements($requirements); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function screenshot($screenshot); + + public function softwareAddOn($softwareAddOn); + + public function softwareHelp($softwareHelp); + + public function softwareRequirements($softwareRequirements); + + public function softwareVersion($softwareVersion); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -202,6 +218,12 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function storageRequirements($storageRequirements); + + public function subjectOf($subjectOf); + + public function supportingData($supportingData); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -216,34 +238,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/SoftwareSourceCodeContract.php b/src/Contracts/SoftwareSourceCodeContract.php index 7aed3879a..54001a78c 100644 --- a/src/Contracts/SoftwareSourceCodeContract.php +++ b/src/Contracts/SoftwareSourceCodeContract.php @@ -4,20 +4,6 @@ interface SoftwareSourceCodeContract { - public function codeRepository($codeRepository); - - public function codeSampleType($codeSampleType); - - public function programmingLanguage($programmingLanguage); - - public function runtime($runtime); - - public function runtimePlatform($runtimePlatform); - - public function sampleType($sampleType); - - public function targetProduct($targetProduct); - public function about($about); public function accessMode($accessMode); @@ -36,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -56,6 +46,10 @@ public function character($character); public function citation($citation); + public function codeRepository($codeRepository); + + public function codeSampleType($codeSampleType); + public function comment($comment); public function commentCount($commentCount); @@ -78,6 +72,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -106,6 +104,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -132,16 +134,24 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function programmingLanguage($programmingLanguage); + public function provider($provider); public function publication($publication); @@ -158,6 +168,14 @@ public function review($review); public function reviews($reviews); + public function runtime($runtime); + + public function runtimePlatform($runtimePlatform); + + public function sameAs($sameAs); + + public function sampleType($sampleType); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -168,6 +186,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + + public function targetProduct($targetProduct); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -182,34 +204,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/SomeProductsContract.php b/src/Contracts/SomeProductsContract.php index ce94a2176..965903d30 100644 --- a/src/Contracts/SomeProductsContract.php +++ b/src/Contracts/SomeProductsContract.php @@ -4,12 +4,14 @@ interface SomeProductsContract { - public function inventoryLevel($inventoryLevel); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function audience($audience); public function award($award); @@ -24,6 +26,10 @@ public function color($color); public function depth($depth); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function gtin12($gtin12); public function gtin13($gtin13); @@ -34,6 +40,12 @@ public function gtin8($gtin8); public function height($height); + public function identifier($identifier); + + public function image($image); + + public function inventoryLevel($inventoryLevel); + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor); public function isConsumableFor($isConsumableFor); @@ -46,6 +58,8 @@ public function itemCondition($itemCondition); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function manufacturer($manufacturer); public function material($material); @@ -54,8 +68,12 @@ public function model($model); public function mpn($mpn); + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function productID($productID); public function productionDate($productionDate); @@ -68,36 +86,18 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function sku($sku); public function slogan($slogan); - public function weight($weight); - - public function width($width); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); + public function weight($weight); + + public function width($width); + } diff --git a/src/Contracts/SportingGoodsStoreContract.php b/src/Contracts/SportingGoodsStoreContract.php index a0bc331bd..66ba5fcd4 100644 --- a/src/Contracts/SportingGoodsStoreContract.php +++ b/src/Contracts/SportingGoodsStoreContract.php @@ -4,34 +4,48 @@ interface SportingGoodsStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/SportsActivityLocationContract.php b/src/Contracts/SportsActivityLocationContract.php index 856aa325e..da431f719 100644 --- a/src/Contracts/SportsActivityLocationContract.php +++ b/src/Contracts/SportsActivityLocationContract.php @@ -4,34 +4,48 @@ interface SportsActivityLocationContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/SportsClubContract.php b/src/Contracts/SportsClubContract.php index 6950206cb..c409ad2a4 100644 --- a/src/Contracts/SportsClubContract.php +++ b/src/Contracts/SportsClubContract.php @@ -4,34 +4,48 @@ interface SportsClubContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/SportsEventContract.php b/src/Contracts/SportsEventContract.php index e3e016c76..9d7e81888 100644 --- a/src/Contracts/SportsEventContract.php +++ b/src/Contracts/SportsEventContract.php @@ -4,30 +4,36 @@ interface SportsEventContract { - public function awayTeam($awayTeam); - - public function competitor($competitor); - - public function homeTeam($homeTeam); - public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); public function audience($audience); + public function awayTeam($awayTeam); + + public function competitor($competitor); + public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -38,14 +44,24 @@ public function eventStatus($eventStatus); public function funder($funder); + public function homeTeam($homeTeam); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -54,6 +70,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -62,6 +80,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -70,38 +90,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/SportsOrganizationContract.php b/src/Contracts/SportsOrganizationContract.php index 2eb698045..af6afeec1 100644 --- a/src/Contracts/SportsOrganizationContract.php +++ b/src/Contracts/SportsOrganizationContract.php @@ -4,12 +4,14 @@ interface SportsOrganizationContract { - public function sport($sport); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -24,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -56,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -66,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -76,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -84,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,36 +116,18 @@ public function slogan($slogan); public function sponsor($sponsor); + public function sport($sport); + public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/SportsTeamContract.php b/src/Contracts/SportsTeamContract.php index 6f214a341..ecf545f6a 100644 --- a/src/Contracts/SportsTeamContract.php +++ b/src/Contracts/SportsTeamContract.php @@ -4,30 +4,36 @@ interface SportsTeamContract { - public function athlete($athlete); - - public function coach($coach); - - public function sport($sport); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); + public function athlete($athlete); + public function award($award); public function awards($awards); public function brand($brand); + public function coach($coach); + public function contactPoint($contactPoint); public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -60,6 +66,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -70,6 +80,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -80,6 +92,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -88,12 +102,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -102,36 +120,18 @@ public function slogan($slogan); public function sponsor($sponsor); + public function sport($sport); + public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/SpreadsheetDigitalDocumentContract.php b/src/Contracts/SpreadsheetDigitalDocumentContract.php index 742e45ceb..a65d87a28 100644 --- a/src/Contracts/SpreadsheetDigitalDocumentContract.php +++ b/src/Contracts/SpreadsheetDigitalDocumentContract.php @@ -4,8 +4,6 @@ interface SpreadsheetDigitalDocumentContract { - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); - public function about($about); public function accessMode($accessMode); @@ -24,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -66,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -90,10 +96,16 @@ public function funder($funder); public function genre($genre); + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); + public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -120,14 +132,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -156,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,34 +192,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/StadiumOrArenaContract.php b/src/Contracts/StadiumOrArenaContract.php index 44751b100..bc92044eb 100644 --- a/src/Contracts/StadiumOrArenaContract.php +++ b/src/Contracts/StadiumOrArenaContract.php @@ -4,178 +4,178 @@ interface StadiumOrArenaContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); - public function branchCode($branchCode); + public function areaServed($areaServed); - public function containedIn($containedIn); + public function award($award); - public function containedInPlace($containedInPlace); + public function awards($awards); - public function containsPlace($containsPlace); + public function branchCode($branchCode); - public function event($event); + public function branchOf($branchOf); - public function events($events); + public function brand($brand); - public function faxNumber($faxNumber); + public function contactPoint($contactPoint); - public function geo($geo); + public function contactPoints($contactPoints); - public function globalLocationNumber($globalLocationNumber); + public function containedIn($containedIn); - public function hasMap($hasMap); + public function containedInPlace($containedInPlace); - public function isAccessibleForFree($isAccessibleForFree); + public function containsPlace($containsPlace); - public function isicV4($isicV4); + public function currenciesAccepted($currenciesAccepted); - public function latitude($latitude); + public function department($department); - public function logo($logo); + public function description($description); - public function longitude($longitude); + public function disambiguatingDescription($disambiguatingDescription); - public function map($map); + public function dissolutionDate($dissolutionDate); - public function maps($maps); + public function duns($duns); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function email($email); - public function openingHoursSpecification($openingHoursSpecification); + public function employee($employee); - public function photo($photo); + public function employees($employees); - public function photos($photos); + public function event($event); - public function publicAccess($publicAccess); + public function events($events); - public function review($review); + public function faxNumber($faxNumber); - public function reviews($reviews); + public function founder($founder); - public function slogan($slogan); + public function founders($founders); - public function smokingAllowed($smokingAllowed); + public function foundingDate($foundingDate); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function foundingLocation($foundingLocation); - public function telephone($telephone); + public function funder($funder); - public function additionalType($additionalType); + public function geo($geo); - public function alternateName($alternateName); + public function globalLocationNumber($globalLocationNumber); - public function description($description); + public function hasMap($hasMap); - public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); + + public function hasPOS($hasPOS); public function identifier($identifier); public function image($image); - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); + public function isAccessibleForFree($isAccessibleForFree); - public function branchOf($branchOf); + public function isicV4($isicV4); - public function currenciesAccepted($currenciesAccepted); + public function latitude($latitude); - public function paymentAccepted($paymentAccepted); + public function legalName($legalName); - public function priceRange($priceRange); + public function leiCode($leiCode); - public function areaServed($areaServed); + public function location($location); - public function award($award); + public function logo($logo); - public function awards($awards); + public function longitude($longitude); - public function brand($brand); + public function mainEntityOfPage($mainEntityOfPage); - public function contactPoint($contactPoint); + public function makesOffer($makesOffer); - public function contactPoints($contactPoints); + public function map($map); - public function department($department); + public function maps($maps); - public function dissolutionDate($dissolutionDate); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function duns($duns); + public function member($member); - public function email($email); + public function memberOf($memberOf); - public function employee($employee); + public function members($members); - public function employees($employees); + public function naics($naics); - public function founder($founder); + public function name($name); - public function founders($founders); + public function numberOfEmployees($numberOfEmployees); - public function foundingDate($foundingDate); + public function offeredBy($offeredBy); - public function foundingLocation($foundingLocation); + public function openingHours($openingHours); - public function funder($funder); + public function openingHoursSpecification($openingHoursSpecification); - public function hasOfferCatalog($hasOfferCatalog); + public function owns($owns); - public function hasPOS($hasPOS); + public function parentOrganization($parentOrganization); - public function legalName($legalName); + public function paymentAccepted($paymentAccepted); - public function leiCode($leiCode); + public function photo($photo); - public function location($location); + public function photos($photos); - public function makesOffer($makesOffer); + public function potentialAction($potentialAction); - public function member($member); + public function priceRange($priceRange); - public function memberOf($memberOf); + public function publicAccess($publicAccess); - public function members($members); + public function publishingPrinciples($publishingPrinciples); - public function naics($naics); + public function review($review); - public function numberOfEmployees($numberOfEmployees); + public function reviews($reviews); - public function offeredBy($offeredBy); + public function sameAs($sameAs); - public function owns($owns); + public function seeks($seeks); - public function parentOrganization($parentOrganization); + public function serviceArea($serviceArea); - public function publishingPrinciples($publishingPrinciples); + public function slogan($slogan); - public function seeks($seeks); + public function smokingAllowed($smokingAllowed); - public function serviceArea($serviceArea); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); + public function telephone($telephone); + + public function url($url); + public function vatID($vatID); } diff --git a/src/Contracts/StateContract.php b/src/Contracts/StateContract.php index 81137d1b0..ecf415c3a 100644 --- a/src/Contracts/StateContract.php +++ b/src/Contracts/StateContract.php @@ -6,10 +6,14 @@ interface StateContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/SteeringPositionValueContract.php b/src/Contracts/SteeringPositionValueContract.php index 24f45203c..01d80e947 100644 --- a/src/Contracts/SteeringPositionValueContract.php +++ b/src/Contracts/SteeringPositionValueContract.php @@ -6,20 +6,6 @@ interface SteeringPositionValueContract { public function additionalProperty($additionalProperty); - public function equal($equal); - - public function greater($greater); - - public function greaterOrEqual($greaterOrEqual); - - public function lesser($lesser); - - public function lesserOrEqual($lesserOrEqual); - - public function nonEqual($nonEqual); - - public function valueReference($valueReference); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -28,14 +14,26 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function equal($equal); + + public function greater($greater); + + public function greaterOrEqual($greaterOrEqual); + public function identifier($identifier); public function image($image); + public function lesser($lesser); + + public function lesserOrEqual($lesserOrEqual); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function nonEqual($nonEqual); + public function potentialAction($potentialAction); public function sameAs($sameAs); @@ -44,4 +42,6 @@ public function subjectOf($subjectOf); public function url($url); + public function valueReference($valueReference); + } diff --git a/src/Contracts/StoreContract.php b/src/Contracts/StoreContract.php index 490da7ac2..86ae53784 100644 --- a/src/Contracts/StoreContract.php +++ b/src/Contracts/StoreContract.php @@ -4,34 +4,48 @@ interface StoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/SubscribeActionContract.php b/src/Contracts/SubscribeActionContract.php index 1624ed6de..c103c4706 100644 --- a/src/Contracts/SubscribeActionContract.php +++ b/src/Contracts/SubscribeActionContract.php @@ -6,48 +6,48 @@ interface SubscribeActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/SubwayStationContract.php b/src/Contracts/SubwayStationContract.php index 5c13eade7..0c0dfd058 100644 --- a/src/Contracts/SubwayStationContract.php +++ b/src/Contracts/SubwayStationContract.php @@ -4,14 +4,16 @@ interface SubwayStationContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/SuiteContract.php b/src/Contracts/SuiteContract.php index 72f8207fe..d9bdb188c 100644 --- a/src/Contracts/SuiteContract.php +++ b/src/Contracts/SuiteContract.php @@ -4,27 +4,19 @@ interface SuiteContract { - public function bed($bed); - - public function numberOfRooms($numberOfRooms); - - public function occupancy($occupancy); - - public function amenityFeature($amenityFeature); - - public function floorSize($floorSize); + public function additionalProperty($additionalProperty); - public function numberOfRooms($numberOfRooms); + public function additionalType($additionalType); - public function permittedUsage($permittedUsage); + public function address($address); - public function petsAllowed($petsAllowed); + public function aggregateRating($aggregateRating); - public function additionalProperty($additionalProperty); + public function alternateName($alternateName); - public function address($address); + public function amenityFeature($amenityFeature); - public function aggregateRating($aggregateRating); + public function bed($bed); public function branchCode($branchCode); @@ -34,18 +26,28 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); public function faxNumber($faxNumber); + public function floorSize($floorSize); + public function geo($geo); public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -56,54 +58,50 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function numberOfRooms($numberOfRooms); + + public function occupancy($occupancy); + public function openingHoursSpecification($openingHoursSpecification); + public function permittedUsage($permittedUsage); + + public function petsAllowed($petsAllowed); + public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/SuspendActionContract.php b/src/Contracts/SuspendActionContract.php index 6487667d0..58d2b859d 100644 --- a/src/Contracts/SuspendActionContract.php +++ b/src/Contracts/SuspendActionContract.php @@ -6,48 +6,48 @@ interface SuspendActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/SynagogueContract.php b/src/Contracts/SynagogueContract.php index 5cae9f72e..2fc09f4ab 100644 --- a/src/Contracts/SynagogueContract.php +++ b/src/Contracts/SynagogueContract.php @@ -4,14 +4,16 @@ interface SynagogueContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/TVClipContract.php b/src/Contracts/TVClipContract.php index 367e6f65e..8a005ae33 100644 --- a/src/Contracts/TVClipContract.php +++ b/src/Contracts/TVClipContract.php @@ -4,26 +4,6 @@ interface TVClipContract { - public function partOfTVSeries($partOfTVSeries); - - public function actor($actor); - - public function actors($actors); - - public function clipNumber($clipNumber); - - public function director($director); - - public function directors($directors); - - public function musicBy($musicBy); - - public function partOfEpisode($partOfEpisode); - - public function partOfSeason($partOfSeason); - - public function partOfSeries($partOfSeries); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -62,6 +50,8 @@ public function character($character); public function citation($citation); + public function clipNumber($clipNumber); + public function comment($comment); public function commentCount($commentCount); @@ -84,6 +74,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -138,14 +140,30 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function partOfEpisode($partOfEpisode); + + public function partOfSeason($partOfSeason); + + public function partOfSeries($partOfSeries); + + public function partOfTVSeries($partOfTVSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -164,6 +182,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -174,6 +194,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/TVEpisodeContract.php b/src/Contracts/TVEpisodeContract.php index 06bab1516..88ef5175a 100644 --- a/src/Contracts/TVEpisodeContract.php +++ b/src/Contracts/TVEpisodeContract.php @@ -4,32 +4,6 @@ interface TVEpisodeContract { - public function countryOfOrigin($countryOfOrigin); - - public function partOfTVSeries($partOfTVSeries); - - public function subtitleLanguage($subtitleLanguage); - - public function actor($actor); - - public function actors($actors); - - public function director($director); - - public function directors($directors); - - public function episodeNumber($episodeNumber); - - public function musicBy($musicBy); - - public function partOfSeason($partOfSeason); - - public function partOfSeries($partOfSeries); - - public function productionCompany($productionCompany); - - public function trailer($trailer); - public function about($about); public function accessMode($accessMode); @@ -48,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -82,6 +64,8 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function countryOfOrigin($countryOfOrigin); + public function creator($creator); public function dateCreated($dateCreated); @@ -90,6 +74,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -104,6 +96,8 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function episodeNumber($episodeNumber); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -118,6 +112,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -144,16 +142,32 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function partOfSeason($partOfSeason); + + public function partOfSeries($partOfSeries); + + public function partOfTVSeries($partOfTVSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -170,6 +184,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -180,6 +196,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + + public function subtitleLanguage($subtitleLanguage); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -190,38 +210,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/TVSeasonContract.php b/src/Contracts/TVSeasonContract.php index 2f25129cd..7ed46cc26 100644 --- a/src/Contracts/TVSeasonContract.php +++ b/src/Contracts/TVSeasonContract.php @@ -4,10 +4,6 @@ interface TVSeasonContract { - public function countryOfOrigin($countryOfOrigin); - - public function partOfTVSeries($partOfTVSeries); - public function about($about); public function accessMode($accessMode); @@ -26,8 +22,14 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -60,6 +62,8 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function countryOfOrigin($countryOfOrigin); + public function creator($creator); public function dateCreated($dateCreated); @@ -68,6 +72,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -82,6 +92,12 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + + public function episode($episode); + + public function episodes($episodes); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -96,6 +112,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -122,16 +142,30 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + + public function numberOfEpisodes($numberOfEpisodes); + public function offers($offers); + public function partOfSeries($partOfSeries); + + public function partOfTVSeries($partOfTVSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -148,8 +182,12 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function seasonNumber($seasonNumber); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -158,6 +196,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,60 +210,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function actor($actor); - - public function director($director); - - public function endDate($endDate); - - public function episode($episode); - - public function episodes($episodes); - - public function numberOfEpisodes($numberOfEpisodes); - - public function partOfSeries($partOfSeries); - - public function productionCompany($productionCompany); - - public function seasonNumber($seasonNumber); - - public function startDate($startDate); - - public function trailer($trailer); - } diff --git a/src/Contracts/TVSeriesContract.php b/src/Contracts/TVSeriesContract.php index 45e096b43..814bd4f39 100644 --- a/src/Contracts/TVSeriesContract.php +++ b/src/Contracts/TVSeriesContract.php @@ -4,36 +4,6 @@ interface TVSeriesContract { - public function actor($actor); - - public function actors($actors); - - public function containsSeason($containsSeason); - - public function countryOfOrigin($countryOfOrigin); - - public function director($director); - - public function directors($directors); - - public function episode($episode); - - public function episodes($episodes); - - public function musicBy($musicBy); - - public function numberOfEpisodes($numberOfEpisodes); - - public function numberOfSeasons($numberOfSeasons); - - public function productionCompany($productionCompany); - - public function season($season); - - public function seasons($seasons); - - public function trailer($trailer); - public function about($about); public function accessMode($accessMode); @@ -52,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -76,6 +54,8 @@ public function comment($comment); public function commentCount($commentCount); + public function containsSeason($containsSeason); + public function contentLocation($contentLocation); public function contentRating($contentRating); @@ -86,6 +66,8 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function countryOfOrigin($countryOfOrigin); + public function creator($creator); public function dateCreated($dateCreated); @@ -94,6 +76,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -108,6 +98,12 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + + public function episode($episode); + + public function episodes($episodes); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -122,6 +118,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -138,6 +138,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -148,16 +150,30 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + + public function numberOfEpisodes($numberOfEpisodes); + + public function numberOfSeasons($numberOfSeasons); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -174,8 +190,14 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function season($season); + + public function seasons($seasons); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -184,6 +206,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -194,46 +220,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function endDate($endDate); - - public function issn($issn); - - public function startDate($startDate); - - public function director($director); - } diff --git a/src/Contracts/TableContract.php b/src/Contracts/TableContract.php index 44f8a5ca3..71235aba4 100644 --- a/src/Contracts/TableContract.php +++ b/src/Contracts/TableContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/TakeActionContract.php b/src/Contracts/TakeActionContract.php index fc1900859..cb37d1f03 100644 --- a/src/Contracts/TakeActionContract.php +++ b/src/Contracts/TakeActionContract.php @@ -4,54 +4,54 @@ interface TakeActionContract { - public function fromLocation($fromLocation); - - public function toLocation($toLocation); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function fromLocation($fromLocation); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function toLocation($toLocation); + public function url($url); } diff --git a/src/Contracts/TattooParlorContract.php b/src/Contracts/TattooParlorContract.php index 010a368fd..ac5db46d8 100644 --- a/src/Contracts/TattooParlorContract.php +++ b/src/Contracts/TattooParlorContract.php @@ -4,34 +4,48 @@ interface TattooParlorContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/TaxiContract.php b/src/Contracts/TaxiContract.php index bf972baaf..c05028778 100644 --- a/src/Contracts/TaxiContract.php +++ b/src/Contracts/TaxiContract.php @@ -4,8 +4,12 @@ interface TaxiContract { + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function audience($audience); @@ -20,18 +24,32 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -40,6 +58,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -50,26 +70,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/TaxiReservationContract.php b/src/Contracts/TaxiReservationContract.php index 5fbbda3f3..6ffac26d2 100644 --- a/src/Contracts/TaxiReservationContract.php +++ b/src/Contracts/TaxiReservationContract.php @@ -4,11 +4,9 @@ interface TaxiReservationContract { - public function partySize($partySize); - - public function pickupLocation($pickupLocation); + public function additionalType($additionalType); - public function pickupTime($pickupTime); + public function alternateName($alternateName); public function bookingAgent($bookingAgent); @@ -16,48 +14,50 @@ public function bookingTime($bookingTime); public function broker($broker); - public function modifiedTime($modifiedTime); - - public function priceCurrency($priceCurrency); + public function description($description); - public function programMembershipUsed($programMembershipUsed); + public function disambiguatingDescription($disambiguatingDescription); - public function provider($provider); + public function identifier($identifier); - public function reservationFor($reservationFor); + public function image($image); - public function reservationId($reservationId); + public function mainEntityOfPage($mainEntityOfPage); - public function reservationStatus($reservationStatus); + public function modifiedTime($modifiedTime); - public function reservedTicket($reservedTicket); + public function name($name); - public function totalPrice($totalPrice); + public function partySize($partySize); - public function underName($underName); + public function pickupLocation($pickupLocation); - public function additionalType($additionalType); + public function pickupTime($pickupTime); - public function alternateName($alternateName); + public function potentialAction($potentialAction); - public function description($description); + public function priceCurrency($priceCurrency); - public function disambiguatingDescription($disambiguatingDescription); + public function programMembershipUsed($programMembershipUsed); - public function identifier($identifier); + public function provider($provider); - public function image($image); + public function reservationFor($reservationFor); - public function mainEntityOfPage($mainEntityOfPage); + public function reservationId($reservationId); - public function name($name); + public function reservationStatus($reservationStatus); - public function potentialAction($potentialAction); + public function reservedTicket($reservedTicket); public function sameAs($sameAs); public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/TaxiServiceContract.php b/src/Contracts/TaxiServiceContract.php index ee949976b..6eadf6292 100644 --- a/src/Contracts/TaxiServiceContract.php +++ b/src/Contracts/TaxiServiceContract.php @@ -4,8 +4,12 @@ interface TaxiServiceContract { + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function audience($audience); @@ -20,18 +24,32 @@ public function broker($broker); public function category($category); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function hasOfferCatalog($hasOfferCatalog); public function hoursAvailable($hoursAvailable); + public function identifier($identifier); + + public function image($image); + public function isRelatedTo($isRelatedTo); public function isSimilarTo($isSimilarTo); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + + public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function produces($produces); public function provider($provider); @@ -40,6 +58,8 @@ public function providerMobility($providerMobility); public function review($review); + public function sameAs($sameAs); + public function serviceArea($serviceArea); public function serviceAudience($serviceAudience); @@ -50,26 +70,6 @@ public function serviceType($serviceType); public function slogan($slogan); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); public function url($url); diff --git a/src/Contracts/TaxiStandContract.php b/src/Contracts/TaxiStandContract.php index aeaa0748f..54c60b8f1 100644 --- a/src/Contracts/TaxiStandContract.php +++ b/src/Contracts/TaxiStandContract.php @@ -4,14 +4,16 @@ interface TaxiStandContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/TechArticleContract.php b/src/Contracts/TechArticleContract.php index 5de291556..6350e0bda 100644 --- a/src/Contracts/TechArticleContract.php +++ b/src/Contracts/TechArticleContract.php @@ -4,24 +4,6 @@ interface TechArticleContract { - public function dependencies($dependencies); - - public function proficiencyLevel($proficiencyLevel); - - public function articleBody($articleBody); - - public function articleSection($articleSection); - - public function pageEnd($pageEnd); - - public function pageStart($pageStart); - - public function pagination($pagination); - - public function speakable($speakable); - - public function wordCount($wordCount); - public function about($about); public function accessMode($accessMode); @@ -40,10 +22,18 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function articleBody($articleBody); + + public function articleSection($articleSection); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -82,6 +72,12 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function dependencies($dependencies); + + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -110,6 +106,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,16 +136,30 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); + public function pageEnd($pageEnd); + + public function pageStart($pageStart); + + public function pagination($pagination); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function proficiencyLevel($proficiencyLevel); + public function provider($provider); public function publication($publication); @@ -162,6 +176,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -170,8 +186,12 @@ public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -186,34 +206,14 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); + public function wordCount($wordCount); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/TelevisionChannelContract.php b/src/Contracts/TelevisionChannelContract.php index 7554055a4..4ca56973b 100644 --- a/src/Contracts/TelevisionChannelContract.php +++ b/src/Contracts/TelevisionChannelContract.php @@ -4,36 +4,36 @@ interface TelevisionChannelContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function broadcastChannelId($broadcastChannelId); public function broadcastFrequency($broadcastFrequency); public function broadcastServiceTier($broadcastServiceTier); - public function genre($genre); - - public function inBroadcastLineup($inBroadcastLineup); - - public function providesBroadcastService($providesBroadcastService); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function genre($genre); + public function identifier($identifier); public function image($image); + public function inBroadcastLineup($inBroadcastLineup); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function providesBroadcastService($providesBroadcastService); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/TelevisionStationContract.php b/src/Contracts/TelevisionStationContract.php index 9f08b20ed..e63803099 100644 --- a/src/Contracts/TelevisionStationContract.php +++ b/src/Contracts/TelevisionStationContract.php @@ -4,34 +4,48 @@ interface TelevisionStationContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/TennisComplexContract.php b/src/Contracts/TennisComplexContract.php index a73c66cd8..3daaedb07 100644 --- a/src/Contracts/TennisComplexContract.php +++ b/src/Contracts/TennisComplexContract.php @@ -4,34 +4,48 @@ interface TennisComplexContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/TextDigitalDocumentContract.php b/src/Contracts/TextDigitalDocumentContract.php index d7d1bef36..a03d26408 100644 --- a/src/Contracts/TextDigitalDocumentContract.php +++ b/src/Contracts/TextDigitalDocumentContract.php @@ -4,8 +4,6 @@ interface TextDigitalDocumentContract { - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); - public function about($about); public function accessMode($accessMode); @@ -24,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -66,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -90,10 +96,16 @@ public function funder($funder); public function genre($genre); + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission); + public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -120,14 +132,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -156,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,34 +192,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/TheaterEventContract.php b/src/Contracts/TheaterEventContract.php index 9fbcaf84a..1f4257a0c 100644 --- a/src/Contracts/TheaterEventContract.php +++ b/src/Contracts/TheaterEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/TheaterGroupContract.php b/src/Contracts/TheaterGroupContract.php index be611b03c..053ed2adc 100644 --- a/src/Contracts/TheaterGroupContract.php +++ b/src/Contracts/TheaterGroupContract.php @@ -4,10 +4,14 @@ interface TheaterGroupContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/TicketContract.php b/src/Contracts/TicketContract.php index 6fd55c4ae..be3237432 100644 --- a/src/Contracts/TicketContract.php +++ b/src/Contracts/TicketContract.php @@ -4,26 +4,12 @@ interface TicketContract { - public function dateIssued($dateIssued); - - public function issuedBy($issuedBy); - - public function priceCurrency($priceCurrency); - - public function ticketNumber($ticketNumber); - - public function ticketToken($ticketToken); - - public function ticketedSeat($ticketedSeat); - - public function totalPrice($totalPrice); - - public function underName($underName); - public function additionalType($additionalType); public function alternateName($alternateName); + public function dateIssued($dateIssued); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -32,16 +18,30 @@ public function identifier($identifier); public function image($image); + public function issuedBy($issuedBy); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); public function potentialAction($potentialAction); + public function priceCurrency($priceCurrency); + public function sameAs($sameAs); public function subjectOf($subjectOf); + public function ticketNumber($ticketNumber); + + public function ticketToken($ticketToken); + + public function ticketedSeat($ticketedSeat); + + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/TieActionContract.php b/src/Contracts/TieActionContract.php index af913ddb3..dba09fe70 100644 --- a/src/Contracts/TieActionContract.php +++ b/src/Contracts/TieActionContract.php @@ -6,48 +6,48 @@ interface TieActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/TipActionContract.php b/src/Contracts/TipActionContract.php index 62d2a239c..a10465cff 100644 --- a/src/Contracts/TipActionContract.php +++ b/src/Contracts/TipActionContract.php @@ -4,58 +4,58 @@ interface TipActionContract { - public function recipient($recipient); + public function actionStatus($actionStatus); - public function price($price); + public function additionalType($additionalType); - public function priceCurrency($priceCurrency); + public function agent($agent); - public function priceSpecification($priceSpecification); + public function alternateName($alternateName); - public function actionStatus($actionStatus); + public function description($description); - public function agent($agent); + public function disambiguatingDescription($disambiguatingDescription); public function endTime($endTime); public function error($error); - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function identifier($identifier); - public function participant($participant); + public function image($image); - public function result($result); + public function instrument($instrument); - public function startTime($startTime); + public function location($location); - public function target($target); + public function mainEntityOfPage($mainEntityOfPage); - public function additionalType($additionalType); + public function name($name); - public function alternateName($alternateName); + public function object($object); - public function description($description); + public function participant($participant); - public function disambiguatingDescription($disambiguatingDescription); + public function potentialAction($potentialAction); - public function identifier($identifier); + public function price($price); - public function image($image); + public function priceCurrency($priceCurrency); - public function mainEntityOfPage($mainEntityOfPage); + public function priceSpecification($priceSpecification); - public function name($name); + public function recipient($recipient); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/TireShopContract.php b/src/Contracts/TireShopContract.php index a2e32d3bc..4975ee212 100644 --- a/src/Contracts/TireShopContract.php +++ b/src/Contracts/TireShopContract.php @@ -4,34 +4,48 @@ interface TireShopContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/TouristAttractionContract.php b/src/Contracts/TouristAttractionContract.php index b3bfab3ff..ffc400eeb 100644 --- a/src/Contracts/TouristAttractionContract.php +++ b/src/Contracts/TouristAttractionContract.php @@ -4,18 +4,20 @@ interface TouristAttractionContract { - public function availableLanguage($availableLanguage); - - public function touristType($touristType); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); + public function availableLanguage($availableLanguage); + public function branchCode($branchCode); public function containedIn($containedIn); @@ -24,6 +26,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -36,6 +42,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -46,53 +56,43 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); + public function subjectOf($subjectOf); - public function sameAs($sameAs); + public function telephone($telephone); - public function subjectOf($subjectOf); + public function touristType($touristType); public function url($url); diff --git a/src/Contracts/TouristInformationCenterContract.php b/src/Contracts/TouristInformationCenterContract.php index 2db9c76bf..7199e6445 100644 --- a/src/Contracts/TouristInformationCenterContract.php +++ b/src/Contracts/TouristInformationCenterContract.php @@ -4,34 +4,48 @@ interface TouristInformationCenterContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/ToyStoreContract.php b/src/Contracts/ToyStoreContract.php index 24f2d6b65..70e6f7621 100644 --- a/src/Contracts/ToyStoreContract.php +++ b/src/Contracts/ToyStoreContract.php @@ -4,34 +4,48 @@ interface ToyStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/TrackActionContract.php b/src/Contracts/TrackActionContract.php index bd156e65f..ff4f8feda 100644 --- a/src/Contracts/TrackActionContract.php +++ b/src/Contracts/TrackActionContract.php @@ -4,52 +4,52 @@ interface TrackActionContract { - public function deliveryMethod($deliveryMethod); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); + public function deliveryMethod($deliveryMethod); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/TradeActionContract.php b/src/Contracts/TradeActionContract.php index 6bf34e0a3..01b440296 100644 --- a/src/Contracts/TradeActionContract.php +++ b/src/Contracts/TradeActionContract.php @@ -4,56 +4,56 @@ interface TradeActionContract { - public function price($price); - - public function priceCurrency($priceCurrency); - - public function priceSpecification($priceSpecification); - public function actionStatus($actionStatus); + public function additionalType($additionalType); + public function agent($agent); - public function endTime($endTime); + public function alternateName($alternateName); - public function error($error); + public function description($description); - public function instrument($instrument); + public function disambiguatingDescription($disambiguatingDescription); - public function location($location); + public function endTime($endTime); - public function object($object); + public function error($error); - public function participant($participant); + public function identifier($identifier); - public function result($result); + public function image($image); - public function startTime($startTime); + public function instrument($instrument); - public function target($target); + public function location($location); - public function additionalType($additionalType); + public function mainEntityOfPage($mainEntityOfPage); - public function alternateName($alternateName); + public function name($name); - public function description($description); + public function object($object); - public function disambiguatingDescription($disambiguatingDescription); + public function participant($participant); - public function identifier($identifier); + public function potentialAction($potentialAction); - public function image($image); + public function price($price); - public function mainEntityOfPage($mainEntityOfPage); + public function priceCurrency($priceCurrency); - public function name($name); + public function priceSpecification($priceSpecification); - public function potentialAction($potentialAction); + public function result($result); public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/TrainReservationContract.php b/src/Contracts/TrainReservationContract.php index 2d01e3b2d..f47b66c87 100644 --- a/src/Contracts/TrainReservationContract.php +++ b/src/Contracts/TrainReservationContract.php @@ -4,14 +4,32 @@ interface TrainReservationContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function bookingAgent($bookingAgent); public function bookingTime($bookingTime); public function broker($broker); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + + public function identifier($identifier); + + public function image($image); + + public function mainEntityOfPage($mainEntityOfPage); + public function modifiedTime($modifiedTime); + public function name($name); + + public function potentialAction($potentialAction); + public function priceCurrency($priceCurrency); public function programMembershipUsed($programMembershipUsed); @@ -26,32 +44,14 @@ public function reservationStatus($reservationStatus); public function reservedTicket($reservedTicket); - public function totalPrice($totalPrice); - - public function underName($underName); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - public function sameAs($sameAs); public function subjectOf($subjectOf); + public function totalPrice($totalPrice); + + public function underName($underName); + public function url($url); } diff --git a/src/Contracts/TrainStationContract.php b/src/Contracts/TrainStationContract.php index 0827a0734..166d07124 100644 --- a/src/Contracts/TrainStationContract.php +++ b/src/Contracts/TrainStationContract.php @@ -4,14 +4,16 @@ interface TrainStationContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/TrainTripContract.php b/src/Contracts/TrainTripContract.php index e93303c26..931de07b2 100644 --- a/src/Contracts/TrainTripContract.php +++ b/src/Contracts/TrainTripContract.php @@ -4,30 +4,22 @@ interface TrainTripContract { + public function additionalType($additionalType); + + public function alternateName($alternateName); + public function arrivalPlatform($arrivalPlatform); public function arrivalStation($arrivalStation); + public function arrivalTime($arrivalTime); + public function departurePlatform($departurePlatform); public function departureStation($departureStation); - public function trainName($trainName); - - public function trainNumber($trainNumber); - - public function arrivalTime($arrivalTime); - public function departureTime($departureTime); - public function offers($offers); - - public function provider($provider); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -40,12 +32,20 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function provider($provider); + public function sameAs($sameAs); public function subjectOf($subjectOf); + public function trainName($trainName); + + public function trainNumber($trainNumber); + public function url($url); } diff --git a/src/Contracts/TransferActionContract.php b/src/Contracts/TransferActionContract.php index 9865ee238..c4b0eb6d4 100644 --- a/src/Contracts/TransferActionContract.php +++ b/src/Contracts/TransferActionContract.php @@ -4,54 +4,54 @@ interface TransferActionContract { - public function fromLocation($fromLocation); - - public function toLocation($toLocation); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function fromLocation($fromLocation); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function toLocation($toLocation); + public function url($url); } diff --git a/src/Contracts/TravelActionContract.php b/src/Contracts/TravelActionContract.php index edc1dbb0c..f27cc6ba2 100644 --- a/src/Contracts/TravelActionContract.php +++ b/src/Contracts/TravelActionContract.php @@ -4,56 +4,56 @@ interface TravelActionContract { - public function distance($distance); - - public function fromLocation($fromLocation); - - public function toLocation($toLocation); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); + public function additionalType($additionalType); - public function participant($participant); + public function agent($agent); - public function result($result); + public function alternateName($alternateName); - public function startTime($startTime); + public function description($description); - public function target($target); + public function disambiguatingDescription($disambiguatingDescription); - public function additionalType($additionalType); + public function distance($distance); - public function alternateName($alternateName); + public function endTime($endTime); - public function description($description); + public function error($error); - public function disambiguatingDescription($disambiguatingDescription); + public function fromLocation($fromLocation); public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function toLocation($toLocation); + public function url($url); } diff --git a/src/Contracts/TravelAgencyContract.php b/src/Contracts/TravelAgencyContract.php index 1896c0caf..798840976 100644 --- a/src/Contracts/TravelAgencyContract.php +++ b/src/Contracts/TravelAgencyContract.php @@ -4,34 +4,48 @@ interface TravelAgencyContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/TripContract.php b/src/Contracts/TripContract.php index 74de52095..7937cc09a 100644 --- a/src/Contracts/TripContract.php +++ b/src/Contracts/TripContract.php @@ -4,18 +4,14 @@ interface TripContract { - public function arrivalTime($arrivalTime); - - public function departureTime($departureTime); - - public function offers($offers); - - public function provider($provider); - public function additionalType($additionalType); public function alternateName($alternateName); + public function arrivalTime($arrivalTime); + + public function departureTime($departureTime); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -28,8 +24,12 @@ public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function offers($offers); + public function potentialAction($potentialAction); + public function provider($provider); + public function sameAs($sameAs); public function subjectOf($subjectOf); diff --git a/src/Contracts/TypeAndQuantityNodeContract.php b/src/Contracts/TypeAndQuantityNodeContract.php index 05ec9c81a..c2287c352 100644 --- a/src/Contracts/TypeAndQuantityNodeContract.php +++ b/src/Contracts/TypeAndQuantityNodeContract.php @@ -4,20 +4,14 @@ interface TypeAndQuantityNodeContract { - public function amountOfThisGood($amountOfThisGood); - - public function businessFunction($businessFunction); - - public function typeOfGood($typeOfGood); - - public function unitCode($unitCode); - - public function unitText($unitText); - public function additionalType($additionalType); public function alternateName($alternateName); + public function amountOfThisGood($amountOfThisGood); + + public function businessFunction($businessFunction); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); @@ -36,6 +30,12 @@ public function sameAs($sameAs); public function subjectOf($subjectOf); + public function typeOfGood($typeOfGood); + + public function unitCode($unitCode); + + public function unitText($unitText); + public function url($url); } diff --git a/src/Contracts/UnRegisterActionContract.php b/src/Contracts/UnRegisterActionContract.php index 27167899a..18f36b5df 100644 --- a/src/Contracts/UnRegisterActionContract.php +++ b/src/Contracts/UnRegisterActionContract.php @@ -6,48 +6,48 @@ interface UnRegisterActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/UnitPriceSpecificationContract.php b/src/Contracts/UnitPriceSpecificationContract.php index bcbacbc12..34961b7e8 100644 --- a/src/Contracts/UnitPriceSpecificationContract.php +++ b/src/Contracts/UnitPriceSpecificationContract.php @@ -4,56 +4,56 @@ interface UnitPriceSpecificationContract { - public function billingIncrement($billingIncrement); + public function additionalType($additionalType); - public function priceType($priceType); + public function alternateName($alternateName); - public function referenceQuantity($referenceQuantity); + public function billingIncrement($billingIncrement); - public function unitCode($unitCode); + public function description($description); - public function unitText($unitText); + public function disambiguatingDescription($disambiguatingDescription); public function eligibleQuantity($eligibleQuantity); public function eligibleTransactionVolume($eligibleTransactionVolume); - public function maxPrice($maxPrice); + public function identifier($identifier); - public function minPrice($minPrice); + public function image($image); - public function price($price); + public function mainEntityOfPage($mainEntityOfPage); - public function priceCurrency($priceCurrency); + public function maxPrice($maxPrice); - public function validFrom($validFrom); + public function minPrice($minPrice); - public function validThrough($validThrough); + public function name($name); - public function valueAddedTaxIncluded($valueAddedTaxIncluded); + public function potentialAction($potentialAction); - public function additionalType($additionalType); + public function price($price); - public function alternateName($alternateName); + public function priceCurrency($priceCurrency); - public function description($description); + public function priceType($priceType); - public function disambiguatingDescription($disambiguatingDescription); + public function referenceQuantity($referenceQuantity); - public function identifier($identifier); + public function sameAs($sameAs); - public function image($image); + public function subjectOf($subjectOf); - public function mainEntityOfPage($mainEntityOfPage); + public function unitCode($unitCode); - public function name($name); + public function unitText($unitText); - public function potentialAction($potentialAction); + public function url($url); - public function sameAs($sameAs); + public function validFrom($validFrom); - public function subjectOf($subjectOf); + public function validThrough($validThrough); - public function url($url); + public function valueAddedTaxIncluded($valueAddedTaxIncluded); } diff --git a/src/Contracts/UpdateActionContract.php b/src/Contracts/UpdateActionContract.php index 9d3e95685..ff8e2693a 100644 --- a/src/Contracts/UpdateActionContract.php +++ b/src/Contracts/UpdateActionContract.php @@ -4,54 +4,54 @@ interface UpdateActionContract { - public function collection($collection); - - public function targetCollection($targetCollection); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); + public function collection($collection); + public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + + public function targetCollection($targetCollection); + public function url($url); } diff --git a/src/Contracts/UseActionContract.php b/src/Contracts/UseActionContract.php index d8c261ffd..4a220e6cc 100644 --- a/src/Contracts/UseActionContract.php +++ b/src/Contracts/UseActionContract.php @@ -6,52 +6,52 @@ interface UseActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/UserBlocksContract.php b/src/Contracts/UserBlocksContract.php index 635ad45f0..6539f0c46 100644 --- a/src/Contracts/UserBlocksContract.php +++ b/src/Contracts/UserBlocksContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserCheckinsContract.php b/src/Contracts/UserCheckinsContract.php index 47c352fea..2f425b65d 100644 --- a/src/Contracts/UserCheckinsContract.php +++ b/src/Contracts/UserCheckinsContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserCommentsContract.php b/src/Contracts/UserCommentsContract.php index 8905a8889..25cf58c99 100644 --- a/src/Contracts/UserCommentsContract.php +++ b/src/Contracts/UserCommentsContract.php @@ -4,34 +4,40 @@ interface UserCommentsContract { - public function commentText($commentText); - - public function commentTime($commentTime); - - public function creator($creator); - - public function discusses($discusses); - - public function replyToUrl($replyToUrl); - public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); public function audience($audience); + public function commentText($commentText); + + public function commentTime($commentTime); + public function composer($composer); public function contributor($contributor); + public function creator($creator); + + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + + public function discusses($discusses); + public function doorTime($doorTime); public function duration($duration); @@ -42,14 +48,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -58,14 +72,20 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); public function remainingAttendeeCapacity($remainingAttendeeCapacity); + public function replyToUrl($replyToUrl); + public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -74,38 +94,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserDownloadsContract.php b/src/Contracts/UserDownloadsContract.php index 97c118422..36a269827 100644 --- a/src/Contracts/UserDownloadsContract.php +++ b/src/Contracts/UserDownloadsContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserInteractionContract.php b/src/Contracts/UserInteractionContract.php index 8c3b7ca73..b8313f5c9 100644 --- a/src/Contracts/UserInteractionContract.php +++ b/src/Contracts/UserInteractionContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserLikesContract.php b/src/Contracts/UserLikesContract.php index 44c66cc89..d826fec58 100644 --- a/src/Contracts/UserLikesContract.php +++ b/src/Contracts/UserLikesContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserPageVisitsContract.php b/src/Contracts/UserPageVisitsContract.php index 67612d960..ad5678a3e 100644 --- a/src/Contracts/UserPageVisitsContract.php +++ b/src/Contracts/UserPageVisitsContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserPlaysContract.php b/src/Contracts/UserPlaysContract.php index 6e711e613..56248144d 100644 --- a/src/Contracts/UserPlaysContract.php +++ b/src/Contracts/UserPlaysContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserPlusOnesContract.php b/src/Contracts/UserPlusOnesContract.php index 2f90e67df..1927141d1 100644 --- a/src/Contracts/UserPlusOnesContract.php +++ b/src/Contracts/UserPlusOnesContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/UserTweetsContract.php b/src/Contracts/UserTweetsContract.php index 9b93c62f1..4b593cd6b 100644 --- a/src/Contracts/UserTweetsContract.php +++ b/src/Contracts/UserTweetsContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/VehicleContract.php b/src/Contracts/VehicleContract.php index c28333b2c..2160b13f2 100644 --- a/src/Contracts/VehicleContract.php +++ b/src/Contracts/VehicleContract.php @@ -4,73 +4,43 @@ interface VehicleContract { - public function cargoVolume($cargoVolume); - - public function dateVehicleFirstRegistered($dateVehicleFirstRegistered); - - public function driveWheelConfiguration($driveWheelConfiguration); - - public function fuelConsumption($fuelConsumption); - - public function fuelEfficiency($fuelEfficiency); - - public function fuelType($fuelType); - - public function knownVehicleDamages($knownVehicleDamages); - - public function mileageFromOdometer($mileageFromOdometer); - - public function numberOfAirbags($numberOfAirbags); - - public function numberOfAxles($numberOfAxles); - - public function numberOfDoors($numberOfDoors); - - public function numberOfForwardGears($numberOfForwardGears); - - public function numberOfPreviousOwners($numberOfPreviousOwners); - - public function productionDate($productionDate); - - public function purchaseDate($purchaseDate); - - public function steeringPosition($steeringPosition); + public function additionalProperty($additionalProperty); - public function vehicleConfiguration($vehicleConfiguration); + public function additionalType($additionalType); - public function vehicleEngine($vehicleEngine); + public function aggregateRating($aggregateRating); - public function vehicleIdentificationNumber($vehicleIdentificationNumber); + public function alternateName($alternateName); - public function vehicleInteriorColor($vehicleInteriorColor); + public function audience($audience); - public function vehicleInteriorType($vehicleInteriorType); + public function award($award); - public function vehicleModelDate($vehicleModelDate); + public function awards($awards); - public function vehicleSeatingCapacity($vehicleSeatingCapacity); + public function brand($brand); - public function vehicleSpecialUsage($vehicleSpecialUsage); + public function cargoVolume($cargoVolume); - public function vehicleTransmission($vehicleTransmission); + public function category($category); - public function additionalProperty($additionalProperty); + public function color($color); - public function aggregateRating($aggregateRating); + public function dateVehicleFirstRegistered($dateVehicleFirstRegistered); - public function audience($audience); + public function depth($depth); - public function award($award); + public function description($description); - public function awards($awards); + public function disambiguatingDescription($disambiguatingDescription); - public function brand($brand); + public function driveWheelConfiguration($driveWheelConfiguration); - public function category($category); + public function fuelConsumption($fuelConsumption); - public function color($color); + public function fuelEfficiency($fuelEfficiency); - public function depth($depth); + public function fuelType($fuelType); public function gtin12($gtin12); @@ -82,6 +52,10 @@ public function gtin8($gtin8); public function height($height); + public function identifier($identifier); + + public function image($image); + public function isAccessoryOrSparePartFor($isAccessoryOrSparePartFor); public function isConsumableFor($isConsumableFor); @@ -92,18 +66,38 @@ public function isSimilarTo($isSimilarTo); public function itemCondition($itemCondition); + public function knownVehicleDamages($knownVehicleDamages); + public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function manufacturer($manufacturer); public function material($material); + public function mileageFromOdometer($mileageFromOdometer); + public function model($model); public function mpn($mpn); + public function name($name); + + public function numberOfAirbags($numberOfAirbags); + + public function numberOfAxles($numberOfAxles); + + public function numberOfDoors($numberOfDoors); + + public function numberOfForwardGears($numberOfForwardGears); + + public function numberOfPreviousOwners($numberOfPreviousOwners); + public function offers($offers); + public function potentialAction($potentialAction); + public function productID($productID); public function productionDate($productionDate); @@ -116,36 +110,38 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function sku($sku); public function slogan($slogan); - public function weight($weight); + public function steeringPosition($steeringPosition); - public function width($width); + public function subjectOf($subjectOf); - public function additionalType($additionalType); + public function url($url); - public function alternateName($alternateName); + public function vehicleConfiguration($vehicleConfiguration); - public function description($description); + public function vehicleEngine($vehicleEngine); - public function disambiguatingDescription($disambiguatingDescription); + public function vehicleIdentificationNumber($vehicleIdentificationNumber); - public function identifier($identifier); + public function vehicleInteriorColor($vehicleInteriorColor); - public function image($image); + public function vehicleInteriorType($vehicleInteriorType); - public function mainEntityOfPage($mainEntityOfPage); + public function vehicleModelDate($vehicleModelDate); - public function name($name); + public function vehicleSeatingCapacity($vehicleSeatingCapacity); - public function potentialAction($potentialAction); + public function vehicleSpecialUsage($vehicleSpecialUsage); - public function sameAs($sameAs); + public function vehicleTransmission($vehicleTransmission); - public function subjectOf($subjectOf); + public function weight($weight); - public function url($url); + public function width($width); } diff --git a/src/Contracts/VideoGalleryContract.php b/src/Contracts/VideoGalleryContract.php index 5d54c5f7f..793a9de5f 100644 --- a/src/Contracts/VideoGalleryContract.php +++ b/src/Contracts/VideoGalleryContract.php @@ -4,26 +4,6 @@ interface VideoGalleryContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/VideoGameClipContract.php b/src/Contracts/VideoGameClipContract.php index ea59b2aa9..ed88c2aeb 100644 --- a/src/Contracts/VideoGameClipContract.php +++ b/src/Contracts/VideoGameClipContract.php @@ -4,24 +4,6 @@ interface VideoGameClipContract { - public function actor($actor); - - public function actors($actors); - - public function clipNumber($clipNumber); - - public function director($director); - - public function directors($directors); - - public function musicBy($musicBy); - - public function partOfEpisode($partOfEpisode); - - public function partOfSeason($partOfSeason); - - public function partOfSeries($partOfSeries); - public function about($about); public function accessMode($accessMode); @@ -40,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -60,6 +50,8 @@ public function character($character); public function citation($citation); + public function clipNumber($clipNumber); + public function comment($comment); public function commentCount($commentCount); @@ -82,6 +74,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -110,6 +110,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -136,14 +140,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function partOfEpisode($partOfEpisode); + + public function partOfSeason($partOfSeason); + + public function partOfSeries($partOfSeries); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -162,6 +180,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -172,6 +192,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -186,34 +208,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/VideoGameContract.php b/src/Contracts/VideoGameContract.php index 00793c00f..8ebf0e1b2 100644 --- a/src/Contracts/VideoGameContract.php +++ b/src/Contracts/VideoGameContract.php @@ -4,76 +4,6 @@ interface VideoGameContract { - public function actor($actor); - - public function actors($actors); - - public function cheatCode($cheatCode); - - public function director($director); - - public function directors($directors); - - public function gamePlatform($gamePlatform); - - public function gameServer($gameServer); - - public function gameTip($gameTip); - - public function musicBy($musicBy); - - public function playMode($playMode); - - public function trailer($trailer); - - public function applicationCategory($applicationCategory); - - public function applicationSubCategory($applicationSubCategory); - - public function applicationSuite($applicationSuite); - - public function availableOnDevice($availableOnDevice); - - public function countriesNotSupported($countriesNotSupported); - - public function countriesSupported($countriesSupported); - - public function device($device); - - public function downloadUrl($downloadUrl); - - public function featureList($featureList); - - public function fileSize($fileSize); - - public function installUrl($installUrl); - - public function memoryRequirements($memoryRequirements); - - public function operatingSystem($operatingSystem); - - public function permissions($permissions); - - public function processorRequirements($processorRequirements); - - public function releaseNotes($releaseNotes); - - public function requirements($requirements); - - public function screenshot($screenshot); - - public function softwareAddOn($softwareAddOn); - - public function softwareHelp($softwareHelp); - - public function softwareRequirements($softwareRequirements); - - public function softwareVersion($softwareVersion); - - public function storageRequirements($storageRequirements); - - public function supportingData($supportingData); - public function about($about); public function accessMode($accessMode); @@ -92,10 +22,24 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function applicationCategory($applicationCategory); + + public function applicationSubCategory($applicationSubCategory); + + public function applicationSuite($applicationSuite); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -104,12 +48,18 @@ public function audio($audio); public function author($author); + public function availableOnDevice($availableOnDevice); + public function award($award); public function awards($awards); public function character($character); + public function characterAttribute($characterAttribute); + + public function cheatCode($cheatCode); + public function citation($citation); public function comment($comment); @@ -126,6 +76,10 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function countriesNotSupported($countriesNotSupported); + + public function countriesSupported($countriesSupported); + public function creator($creator); public function dateCreated($dateCreated); @@ -134,8 +88,20 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function device($device); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function downloadUrl($downloadUrl); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -152,18 +118,38 @@ public function exampleOfWork($exampleOfWork); public function expires($expires); + public function featureList($featureList); + public function fileFormat($fileFormat); + public function fileSize($fileSize); + public function funder($funder); + public function gameItem($gameItem); + + public function gameLocation($gameLocation); + + public function gamePlatform($gamePlatform); + + public function gameServer($gameServer); + + public function gameTip($gameTip); + public function genre($genre); public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function installUrl($installUrl); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -188,14 +174,34 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); + public function memoryRequirements($memoryRequirements); + public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + + public function numberOfPlayers($numberOfPlayers); + public function offers($offers); + public function operatingSystem($operatingSystem); + + public function permissions($permissions); + + public function playMode($playMode); + public function position($position); + public function potentialAction($potentialAction); + + public function processorRequirements($processorRequirements); + public function producer($producer); public function provider($provider); @@ -206,16 +212,34 @@ public function publisher($publisher); public function publishingPrinciples($publishingPrinciples); + public function quest($quest); + public function recordedAt($recordedAt); + public function releaseNotes($releaseNotes); + public function releasedEvent($releasedEvent); + public function requirements($requirements); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function screenshot($screenshot); + + public function softwareAddOn($softwareAddOn); + + public function softwareHelp($softwareHelp); + + public function softwareRequirements($softwareRequirements); + + public function softwareVersion($softwareVersion); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -224,6 +248,12 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function storageRequirements($storageRequirements); + + public function subjectOf($subjectOf); + + public function supportingData($supportingData); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -234,48 +264,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function characterAttribute($characterAttribute); - - public function gameItem($gameItem); - - public function gameLocation($gameLocation); - - public function numberOfPlayers($numberOfPlayers); - - public function quest($quest); - } diff --git a/src/Contracts/VideoGameSeriesContract.php b/src/Contracts/VideoGameSeriesContract.php index 5206b9377..df616cf26 100644 --- a/src/Contracts/VideoGameSeriesContract.php +++ b/src/Contracts/VideoGameSeriesContract.php @@ -4,56 +4,6 @@ interface VideoGameSeriesContract { - public function actor($actor); - - public function actors($actors); - - public function characterAttribute($characterAttribute); - - public function cheatCode($cheatCode); - - public function containsSeason($containsSeason); - - public function director($director); - - public function directors($directors); - - public function episode($episode); - - public function episodes($episodes); - - public function gameItem($gameItem); - - public function gameLocation($gameLocation); - - public function gamePlatform($gamePlatform); - - public function musicBy($musicBy); - - public function numberOfEpisodes($numberOfEpisodes); - - public function numberOfPlayers($numberOfPlayers); - - public function numberOfSeasons($numberOfSeasons); - - public function playMode($playMode); - - public function productionCompany($productionCompany); - - public function quest($quest); - - public function season($season); - - public function seasons($seasons); - - public function trailer($trailer); - - public function endDate($endDate); - - public function issn($issn); - - public function startDate($startDate); - public function about($about); public function accessMode($accessMode); @@ -72,8 +22,16 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -90,12 +48,18 @@ public function awards($awards); public function character($character); + public function characterAttribute($characterAttribute); + + public function cheatCode($cheatCode); + public function citation($citation); public function comment($comment); public function commentCount($commentCount); + public function containsSeason($containsSeason); + public function contentLocation($contentLocation); public function contentRating($contentRating); @@ -114,6 +78,14 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -128,6 +100,12 @@ public function encodingFormat($encodingFormat); public function encodings($encodings); + public function endDate($endDate); + + public function episode($episode); + + public function episodes($episodes); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -136,12 +114,22 @@ public function fileFormat($fileFormat); public function funder($funder); + public function gameItem($gameItem); + + public function gameLocation($gameLocation); + + public function gamePlatform($gamePlatform); + public function genre($genre); public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -158,6 +146,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -168,16 +158,34 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + + public function numberOfEpisodes($numberOfEpisodes); + + public function numberOfPlayers($numberOfPlayers); + + public function numberOfSeasons($numberOfSeasons); + public function offers($offers); + public function playMode($playMode); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -186,6 +194,8 @@ public function publisher($publisher); public function publishingPrinciples($publishingPrinciples); + public function quest($quest); + public function recordedAt($recordedAt); public function releasedEvent($releasedEvent); @@ -194,8 +204,14 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function season($season); + + public function seasons($seasons); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -204,6 +220,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startDate($startDate); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -214,40 +234,18 @@ public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function trailer($trailer); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function director($director); - } diff --git a/src/Contracts/VideoObjectContract.php b/src/Contracts/VideoObjectContract.php index 49f3d018e..2d41e2051 100644 --- a/src/Contracts/VideoObjectContract.php +++ b/src/Contracts/VideoObjectContract.php @@ -4,60 +4,6 @@ interface VideoObjectContract { - public function actor($actor); - - public function actors($actors); - - public function caption($caption); - - public function director($director); - - public function directors($directors); - - public function musicBy($musicBy); - - public function thumbnail($thumbnail); - - public function transcript($transcript); - - public function videoFrameSize($videoFrameSize); - - public function videoQuality($videoQuality); - - public function associatedArticle($associatedArticle); - - public function bitrate($bitrate); - - public function contentSize($contentSize); - - public function contentUrl($contentUrl); - - public function duration($duration); - - public function embedUrl($embedUrl); - - public function encodesCreativeWork($encodesCreativeWork); - - public function encodingFormat($encodingFormat); - - public function endTime($endTime); - - public function height($height); - - public function playerType($playerType); - - public function productionCompany($productionCompany); - - public function regionsAllowed($regionsAllowed); - - public function requiresSubscription($requiresSubscription); - - public function startTime($startTime); - - public function uploadDate($uploadDate); - - public function width($width); - public function about($about); public function accessMode($accessMode); @@ -76,10 +22,20 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function actor($actor); + + public function actors($actors); + + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function associatedArticle($associatedArticle); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -92,6 +48,10 @@ public function award($award); public function awards($awards); + public function bitrate($bitrate); + + public function caption($caption); + public function character($character); public function citation($citation); @@ -104,6 +64,10 @@ public function contentLocation($contentLocation); public function contentRating($contentRating); + public function contentSize($contentSize); + + public function contentUrl($contentUrl); + public function contributor($contributor); public function copyrightHolder($copyrightHolder); @@ -118,18 +82,36 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function director($director); + + public function directors($directors); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function duration($duration); + public function editor($editor); public function educationalAlignment($educationalAlignment); public function educationalUse($educationalUse); + public function embedUrl($embedUrl); + + public function encodesCreativeWork($encodesCreativeWork); + public function encoding($encoding); + public function encodingFormat($encodingFormat); + public function encodings($encodings); + public function endTime($endTime); + public function exampleOfWork($exampleOfWork); public function expires($expires); @@ -144,6 +126,12 @@ public function hasPart($hasPart); public function headline($headline); + public function height($height); + + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -170,16 +158,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function musicBy($musicBy); + + public function name($name); + public function offers($offers); + public function playerType($playerType); + public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); + public function productionCompany($productionCompany); + public function provider($provider); public function publication($publication); @@ -190,12 +190,18 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function regionsAllowed($regionsAllowed); + public function releasedEvent($releasedEvent); + public function requiresSubscription($requiresSubscription); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -206,48 +212,42 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function startTime($startTime); + + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); public function text($text); + public function thumbnail($thumbnail); + public function thumbnailUrl($thumbnailUrl); public function timeRequired($timeRequired); + public function transcript($transcript); + public function translator($translator); public function typicalAgeRange($typicalAgeRange); - public function version($version); - - public function video($video); - - public function workExample($workExample); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); + public function uploadDate($uploadDate); - public function image($image); + public function url($url); - public function mainEntityOfPage($mainEntityOfPage); + public function version($version); - public function name($name); + public function video($video); - public function potentialAction($potentialAction); + public function videoFrameSize($videoFrameSize); - public function sameAs($sameAs); + public function videoQuality($videoQuality); - public function subjectOf($subjectOf); + public function width($width); - public function url($url); + public function workExample($workExample); } diff --git a/src/Contracts/ViewActionContract.php b/src/Contracts/ViewActionContract.php index 320578f8d..755b162ee 100644 --- a/src/Contracts/ViewActionContract.php +++ b/src/Contracts/ViewActionContract.php @@ -6,52 +6,52 @@ interface ViewActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/VisualArtsEventContract.php b/src/Contracts/VisualArtsEventContract.php index 11ec658c5..5a0f9bb4b 100644 --- a/src/Contracts/VisualArtsEventContract.php +++ b/src/Contracts/VisualArtsEventContract.php @@ -8,8 +8,12 @@ public function about($about); public function actor($actor); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function attendee($attendee); public function attendees($attendees); @@ -20,8 +24,12 @@ public function composer($composer); public function contributor($contributor); + public function description($description); + public function director($director); + public function disambiguatingDescription($disambiguatingDescription); + public function doorTime($doorTime); public function duration($duration); @@ -32,14 +40,22 @@ public function eventStatus($eventStatus); public function funder($funder); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function isAccessibleForFree($isAccessibleForFree); public function location($location); + public function mainEntityOfPage($mainEntityOfPage); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function offers($offers); public function organizer($organizer); @@ -48,6 +64,8 @@ public function performer($performer); public function performers($performers); + public function potentialAction($potentialAction); + public function previousStartDate($previousStartDate); public function recordedIn($recordedIn); @@ -56,6 +74,8 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity); public function review($review); + public function sameAs($sameAs); + public function sponsor($sponsor); public function startDate($startDate); @@ -64,38 +84,18 @@ public function subEvent($subEvent); public function subEvents($subEvents); + public function subjectOf($subjectOf); + public function superEvent($superEvent); public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function workFeatured($workFeatured); public function workPerformed($workPerformed); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/VisualArtworkContract.php b/src/Contracts/VisualArtworkContract.php index 55509840c..66d71a0be 100644 --- a/src/Contracts/VisualArtworkContract.php +++ b/src/Contracts/VisualArtworkContract.php @@ -4,16 +4,6 @@ interface VisualArtworkContract { - public function artEdition($artEdition); - - public function artMedium($artMedium); - - public function artform($artform); - - public function artworkSurface($artworkSurface); - - public function surface($surface); - public function about($about); public function accessMode($accessMode); @@ -32,10 +22,22 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function artEdition($artEdition); + + public function artMedium($artMedium); + + public function artform($artform); + + public function artworkSurface($artworkSurface); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -74,6 +76,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -102,6 +108,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -128,14 +138,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -154,6 +170,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -164,6 +182,10 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + + public function surface($surface); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -178,34 +200,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/VolcanoContract.php b/src/Contracts/VolcanoContract.php index 2ef9adad3..01ec44e54 100644 --- a/src/Contracts/VolcanoContract.php +++ b/src/Contracts/VolcanoContract.php @@ -6,10 +6,14 @@ interface VolcanoContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/VoteActionContract.php b/src/Contracts/VoteActionContract.php index 16ede95a1..d5da7e15d 100644 --- a/src/Contracts/VoteActionContract.php +++ b/src/Contracts/VoteActionContract.php @@ -4,56 +4,56 @@ interface VoteActionContract { - public function candidate($candidate); - public function actionOption($actionOption); - public function option($option); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); + public function additionalType($additionalType); - public function error($error); + public function agent($agent); - public function instrument($instrument); + public function alternateName($alternateName); - public function location($location); + public function candidate($candidate); - public function object($object); + public function description($description); - public function participant($participant); + public function disambiguatingDescription($disambiguatingDescription); - public function result($result); + public function endTime($endTime); - public function startTime($startTime); + public function error($error); - public function target($target); + public function identifier($identifier); - public function additionalType($additionalType); + public function image($image); - public function alternateName($alternateName); + public function instrument($instrument); - public function description($description); + public function location($location); - public function disambiguatingDescription($disambiguatingDescription); + public function mainEntityOfPage($mainEntityOfPage); - public function identifier($identifier); + public function name($name); - public function image($image); + public function object($object); - public function mainEntityOfPage($mainEntityOfPage); + public function option($option); - public function name($name); + public function participant($participant); public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/WPAdBlockContract.php b/src/Contracts/WPAdBlockContract.php index 992529a4c..9a1b0cfd9 100644 --- a/src/Contracts/WPAdBlockContract.php +++ b/src/Contracts/WPAdBlockContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/WPFooterContract.php b/src/Contracts/WPFooterContract.php index b8a06eda8..b4a2ee021 100644 --- a/src/Contracts/WPFooterContract.php +++ b/src/Contracts/WPFooterContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/WPHeaderContract.php b/src/Contracts/WPHeaderContract.php index 838a3d901..965c3f6c5 100644 --- a/src/Contracts/WPHeaderContract.php +++ b/src/Contracts/WPHeaderContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/WPSideBarContract.php b/src/Contracts/WPSideBarContract.php index b7dced5bc..963c5776b 100644 --- a/src/Contracts/WPSideBarContract.php +++ b/src/Contracts/WPSideBarContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/WantActionContract.php b/src/Contracts/WantActionContract.php index 3c14492c3..f4df47346 100644 --- a/src/Contracts/WantActionContract.php +++ b/src/Contracts/WantActionContract.php @@ -6,48 +6,48 @@ interface WantActionContract { public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/WarrantyPromiseContract.php b/src/Contracts/WarrantyPromiseContract.php index a7e3317c4..c32bff970 100644 --- a/src/Contracts/WarrantyPromiseContract.php +++ b/src/Contracts/WarrantyPromiseContract.php @@ -4,10 +4,6 @@ interface WarrantyPromiseContract { - public function durationOfWarranty($durationOfWarranty); - - public function warrantyScope($warrantyScope); - public function additionalType($additionalType); public function alternateName($alternateName); @@ -16,6 +12,8 @@ public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function durationOfWarranty($durationOfWarranty); + public function identifier($identifier); public function image($image); @@ -32,4 +30,6 @@ public function subjectOf($subjectOf); public function url($url); + public function warrantyScope($warrantyScope); + } diff --git a/src/Contracts/WatchActionContract.php b/src/Contracts/WatchActionContract.php index a6461925e..c34d274a6 100644 --- a/src/Contracts/WatchActionContract.php +++ b/src/Contracts/WatchActionContract.php @@ -6,52 +6,52 @@ interface WatchActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/WaterfallContract.php b/src/Contracts/WaterfallContract.php index a94bdd62c..408db1a04 100644 --- a/src/Contracts/WaterfallContract.php +++ b/src/Contracts/WaterfallContract.php @@ -6,10 +6,14 @@ interface WaterfallContract { public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -20,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -32,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -42,54 +54,42 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/Contracts/WearActionContract.php b/src/Contracts/WearActionContract.php index bcefdb04b..89274b637 100644 --- a/src/Contracts/WearActionContract.php +++ b/src/Contracts/WearActionContract.php @@ -6,52 +6,52 @@ interface WearActionContract { public function actionAccessibilityRequirement($actionAccessibilityRequirement); - public function expectsAcceptanceOf($expectsAcceptanceOf); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + + public function expectsAcceptanceOf($expectsAcceptanceOf); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/WebApplicationContract.php b/src/Contracts/WebApplicationContract.php index 1dc619af3..f66d71766 100644 --- a/src/Contracts/WebApplicationContract.php +++ b/src/Contracts/WebApplicationContract.php @@ -4,56 +4,6 @@ interface WebApplicationContract { - public function browserRequirements($browserRequirements); - - public function applicationCategory($applicationCategory); - - public function applicationSubCategory($applicationSubCategory); - - public function applicationSuite($applicationSuite); - - public function availableOnDevice($availableOnDevice); - - public function countriesNotSupported($countriesNotSupported); - - public function countriesSupported($countriesSupported); - - public function device($device); - - public function downloadUrl($downloadUrl); - - public function featureList($featureList); - - public function fileSize($fileSize); - - public function installUrl($installUrl); - - public function memoryRequirements($memoryRequirements); - - public function operatingSystem($operatingSystem); - - public function permissions($permissions); - - public function processorRequirements($processorRequirements); - - public function releaseNotes($releaseNotes); - - public function requirements($requirements); - - public function screenshot($screenshot); - - public function softwareAddOn($softwareAddOn); - - public function softwareHelp($softwareHelp); - - public function softwareRequirements($softwareRequirements); - - public function softwareVersion($softwareVersion); - - public function storageRequirements($storageRequirements); - - public function supportingData($supportingData); - public function about($about); public function accessMode($accessMode); @@ -72,10 +22,20 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); + public function applicationCategory($applicationCategory); + + public function applicationSubCategory($applicationSubCategory); + + public function applicationSuite($applicationSuite); + public function associatedMedia($associatedMedia); public function audience($audience); @@ -84,10 +44,14 @@ public function audio($audio); public function author($author); + public function availableOnDevice($availableOnDevice); + public function award($award); public function awards($awards); + public function browserRequirements($browserRequirements); + public function character($character); public function citation($citation); @@ -106,6 +70,10 @@ public function copyrightHolder($copyrightHolder); public function copyrightYear($copyrightYear); + public function countriesNotSupported($countriesNotSupported); + + public function countriesSupported($countriesSupported); + public function creator($creator); public function dateCreated($dateCreated); @@ -114,8 +82,16 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function device($device); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); + public function downloadUrl($downloadUrl); + public function editor($editor); public function educationalAlignment($educationalAlignment); @@ -132,8 +108,12 @@ public function exampleOfWork($exampleOfWork); public function expires($expires); + public function featureList($featureList); + public function fileFormat($fileFormat); + public function fileSize($fileSize); + public function funder($funder); public function genre($genre); @@ -142,8 +122,14 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); + public function installUrl($installUrl); + public function interactionStatistic($interactionStatistic); public function interactivityType($interactivityType); @@ -168,14 +154,28 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); + public function memoryRequirements($memoryRequirements); + public function mentions($mentions); + public function name($name); + public function offers($offers); + public function operatingSystem($operatingSystem); + + public function permissions($permissions); + public function position($position); + public function potentialAction($potentialAction); + + public function processorRequirements($processorRequirements); + public function producer($producer); public function provider($provider); @@ -188,14 +188,30 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function releaseNotes($releaseNotes); + public function releasedEvent($releasedEvent); + public function requirements($requirements); + public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function screenshot($screenshot); + + public function softwareAddOn($softwareAddOn); + + public function softwareHelp($softwareHelp); + + public function softwareRequirements($softwareRequirements); + + public function softwareVersion($softwareVersion); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); @@ -204,6 +220,12 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function storageRequirements($storageRequirements); + + public function subjectOf($subjectOf); + + public function supportingData($supportingData); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -218,34 +240,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/WebPageContract.php b/src/Contracts/WebPageContract.php index f07f6bd0a..9ca0e2f2e 100644 --- a/src/Contracts/WebPageContract.php +++ b/src/Contracts/WebPageContract.php @@ -4,26 +4,6 @@ interface WebPageContract { - public function breadcrumb($breadcrumb); - - public function lastReviewed($lastReviewed); - - public function mainContentOfPage($mainContentOfPage); - - public function primaryImageOfPage($primaryImageOfPage); - - public function relatedLink($relatedLink); - - public function reviewedBy($reviewedBy); - - public function significantLink($significantLink); - - public function significantLinks($significantLinks); - - public function speakable($speakable); - - public function specialty($specialty); - public function about($about); public function accessMode($accessMode); @@ -42,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -58,6 +42,8 @@ public function award($award); public function awards($awards); + public function breadcrumb($breadcrumb); + public function character($character); public function citation($citation); @@ -84,6 +70,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -112,6 +102,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -130,22 +124,34 @@ public function isPartOf($isPartOf); public function keywords($keywords); + public function lastReviewed($lastReviewed); + public function learningResourceType($learningResourceType); public function license($license); public function locationCreated($locationCreated); + public function mainContentOfPage($mainContentOfPage); + public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + + public function primaryImageOfPage($primaryImageOfPage); + public function producer($producer); public function provider($provider); @@ -158,22 +164,38 @@ public function publishingPrinciples($publishingPrinciples); public function recordedAt($recordedAt); + public function relatedLink($relatedLink); + public function releasedEvent($releasedEvent); public function review($review); + public function reviewedBy($reviewedBy); + public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); + public function significantLink($significantLink); + + public function significantLinks($significantLinks); + public function sourceOrganization($sourceOrganization); public function spatial($spatial); public function spatialCoverage($spatialCoverage); + public function speakable($speakable); + + public function specialty($specialty); + public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -188,34 +210,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/WebPageElementContract.php b/src/Contracts/WebPageElementContract.php index dad55217d..e3881c821 100644 --- a/src/Contracts/WebPageElementContract.php +++ b/src/Contracts/WebPageElementContract.php @@ -22,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -64,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -92,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -118,14 +130,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -144,6 +162,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -154,6 +174,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -168,34 +190,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/WebSiteContract.php b/src/Contracts/WebSiteContract.php index 9f6d81652..9aa4e7b44 100644 --- a/src/Contracts/WebSiteContract.php +++ b/src/Contracts/WebSiteContract.php @@ -4,8 +4,6 @@ interface WebSiteContract { - public function issn($issn); - public function about($about); public function accessMode($accessMode); @@ -24,8 +22,12 @@ public function accessibilitySummary($accessibilitySummary); public function accountablePerson($accountablePerson); + public function additionalType($additionalType); + public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function alternativeHeadline($alternativeHeadline); public function associatedMedia($associatedMedia); @@ -66,6 +68,10 @@ public function dateModified($dateModified); public function datePublished($datePublished); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function discussionUrl($discussionUrl); public function editor($editor); @@ -94,6 +100,10 @@ public function hasPart($hasPart); public function headline($headline); + public function identifier($identifier); + + public function image($image); + public function inLanguage($inLanguage); public function interactionStatistic($interactionStatistic); @@ -110,6 +120,8 @@ public function isFamilyFriendly($isFamilyFriendly); public function isPartOf($isPartOf); + public function issn($issn); + public function keywords($keywords); public function learningResourceType($learningResourceType); @@ -120,14 +132,20 @@ public function locationCreated($locationCreated); public function mainEntity($mainEntity); + public function mainEntityOfPage($mainEntityOfPage); + public function material($material); public function mentions($mentions); + public function name($name); + public function offers($offers); public function position($position); + public function potentialAction($potentialAction); + public function producer($producer); public function provider($provider); @@ -146,6 +164,8 @@ public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function schemaVersion($schemaVersion); public function sourceOrganization($sourceOrganization); @@ -156,6 +176,8 @@ public function spatialCoverage($spatialCoverage); public function sponsor($sponsor); + public function subjectOf($subjectOf); + public function temporal($temporal); public function temporalCoverage($temporalCoverage); @@ -170,34 +192,12 @@ public function translator($translator); public function typicalAgeRange($typicalAgeRange); + public function url($url); + public function version($version); public function video($video); public function workExample($workExample); - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - } diff --git a/src/Contracts/WholesaleStoreContract.php b/src/Contracts/WholesaleStoreContract.php index 335ae5358..624207bf9 100644 --- a/src/Contracts/WholesaleStoreContract.php +++ b/src/Contracts/WholesaleStoreContract.php @@ -4,34 +4,48 @@ interface WholesaleStoreContract { - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -58,14 +72,26 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -74,8 +100,18 @@ public function location($location); public function logo($logo); + public function longitude($longitude); + + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); + public function map($map); + + public function maps($maps); + + public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function member($member); public function memberOf($memberOf); @@ -84,98 +120,62 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); - public function owns($owns); - - public function parentOrganization($parentOrganization); - - public function publishingPrinciples($publishingPrinciples); - - public function review($review); - - public function reviews($reviews); - - public function seeks($seeks); - - public function serviceArea($serviceArea); - - public function slogan($slogan); - - public function sponsor($sponsor); - - public function subOrganization($subOrganization); - - public function taxID($taxID); - - public function telephone($telephone); - - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); - - public function amenityFeature($amenityFeature); - - public function branchCode($branchCode); + public function priceRange($priceRange); - public function containedIn($containedIn); + public function publicAccess($publicAccess); - public function containedInPlace($containedInPlace); + public function publishingPrinciples($publishingPrinciples); - public function containsPlace($containsPlace); + public function review($review); - public function geo($geo); + public function reviews($reviews); - public function hasMap($hasMap); + public function sameAs($sameAs); - public function isAccessibleForFree($isAccessibleForFree); + public function seeks($seeks); - public function latitude($latitude); + public function serviceArea($serviceArea); - public function longitude($longitude); + public function slogan($slogan); - public function map($map); + public function smokingAllowed($smokingAllowed); - public function maps($maps); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function sponsor($sponsor); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/WinActionContract.php b/src/Contracts/WinActionContract.php index 0cbaebdc0..6a64d2b30 100644 --- a/src/Contracts/WinActionContract.php +++ b/src/Contracts/WinActionContract.php @@ -4,52 +4,52 @@ interface WinActionContract { - public function loser($loser); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); - - public function location($location); - - public function object($object); - - public function participant($participant); - - public function result($result); - - public function startTime($startTime); - - public function target($target); - public function additionalType($additionalType); + public function agent($agent); + public function alternateName($alternateName); public function description($description); public function disambiguatingDescription($disambiguatingDescription); + public function endTime($endTime); + + public function error($error); + public function identifier($identifier); public function image($image); + public function instrument($instrument); + + public function location($location); + + public function loser($loser); + public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/WineryContract.php b/src/Contracts/WineryContract.php index 73f656de0..77754a61d 100644 --- a/src/Contracts/WineryContract.php +++ b/src/Contracts/WineryContract.php @@ -6,42 +6,48 @@ interface WineryContract { public function acceptsReservations($acceptsReservations); - public function hasMenu($hasMenu); - - public function menu($menu); - - public function servesCuisine($servesCuisine); - - public function starRating($starRating); - - public function branchOf($branchOf); - - public function currenciesAccepted($currenciesAccepted); - - public function openingHours($openingHours); - - public function paymentAccepted($paymentAccepted); + public function additionalProperty($additionalProperty); - public function priceRange($priceRange); + public function additionalType($additionalType); public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + + public function amenityFeature($amenityFeature); + public function areaServed($areaServed); public function award($award); public function awards($awards); + public function branchCode($branchCode); + + public function branchOf($branchOf); + public function brand($brand); public function contactPoint($contactPoint); public function contactPoints($contactPoints); + public function containedIn($containedIn); + + public function containedInPlace($containedInPlace); + + public function containsPlace($containsPlace); + + public function currenciesAccepted($currenciesAccepted); + public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -68,14 +74,28 @@ public function foundingLocation($foundingLocation); public function funder($funder); + public function geo($geo); + public function globalLocationNumber($globalLocationNumber); + public function hasMap($hasMap); + + public function hasMenu($hasMenu); + public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + + public function isAccessibleForFree($isAccessibleForFree); + public function isicV4($isicV4); + public function latitude($latitude); + public function legalName($legalName); public function leiCode($leiCode); @@ -84,108 +104,88 @@ public function location($location); public function logo($logo); - public function makesOffer($makesOffer); - - public function member($member); - - public function memberOf($memberOf); - - public function members($members); - - public function naics($naics); - - public function numberOfEmployees($numberOfEmployees); - - public function offeredBy($offeredBy); - - public function owns($owns); + public function longitude($longitude); - public function parentOrganization($parentOrganization); + public function mainEntityOfPage($mainEntityOfPage); - public function publishingPrinciples($publishingPrinciples); + public function makesOffer($makesOffer); - public function review($review); + public function map($map); - public function reviews($reviews); + public function maps($maps); - public function seeks($seeks); + public function maximumAttendeeCapacity($maximumAttendeeCapacity); - public function serviceArea($serviceArea); + public function member($member); - public function slogan($slogan); + public function memberOf($memberOf); - public function sponsor($sponsor); + public function members($members); - public function subOrganization($subOrganization); + public function menu($menu); - public function taxID($taxID); + public function naics($naics); - public function telephone($telephone); + public function name($name); - public function vatID($vatID); + public function numberOfEmployees($numberOfEmployees); - public function additionalType($additionalType); + public function offeredBy($offeredBy); - public function alternateName($alternateName); + public function openingHours($openingHours); - public function description($description); + public function openingHoursSpecification($openingHoursSpecification); - public function disambiguatingDescription($disambiguatingDescription); + public function owns($owns); - public function identifier($identifier); + public function parentOrganization($parentOrganization); - public function image($image); + public function paymentAccepted($paymentAccepted); - public function mainEntityOfPage($mainEntityOfPage); + public function photo($photo); - public function name($name); + public function photos($photos); public function potentialAction($potentialAction); - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - - public function url($url); - - public function additionalProperty($additionalProperty); + public function priceRange($priceRange); - public function amenityFeature($amenityFeature); + public function publicAccess($publicAccess); - public function branchCode($branchCode); + public function publishingPrinciples($publishingPrinciples); - public function containedIn($containedIn); + public function review($review); - public function containedInPlace($containedInPlace); + public function reviews($reviews); - public function containsPlace($containsPlace); + public function sameAs($sameAs); - public function geo($geo); + public function seeks($seeks); - public function hasMap($hasMap); + public function servesCuisine($servesCuisine); - public function isAccessibleForFree($isAccessibleForFree); + public function serviceArea($serviceArea); - public function latitude($latitude); + public function slogan($slogan); - public function longitude($longitude); + public function smokingAllowed($smokingAllowed); - public function map($map); + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function maps($maps); + public function sponsor($sponsor); - public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function starRating($starRating); - public function openingHoursSpecification($openingHoursSpecification); + public function subOrganization($subOrganization); - public function photo($photo); + public function subjectOf($subjectOf); - public function photos($photos); + public function taxID($taxID); - public function publicAccess($publicAccess); + public function telephone($telephone); - public function smokingAllowed($smokingAllowed); + public function url($url); - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); + public function vatID($vatID); } diff --git a/src/Contracts/WorkersUnionContract.php b/src/Contracts/WorkersUnionContract.php index e63a8d1fc..24696f21e 100644 --- a/src/Contracts/WorkersUnionContract.php +++ b/src/Contracts/WorkersUnionContract.php @@ -4,10 +4,14 @@ interface WorkersUnionContract { + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function areaServed($areaServed); public function award($award); @@ -22,6 +26,10 @@ public function contactPoints($contactPoints); public function department($department); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function dissolutionDate($dissolutionDate); public function duns($duns); @@ -54,6 +62,10 @@ public function hasOfferCatalog($hasOfferCatalog); public function hasPOS($hasPOS); + public function identifier($identifier); + + public function image($image); + public function isicV4($isicV4); public function legalName($legalName); @@ -64,6 +76,8 @@ public function location($location); public function logo($logo); + public function mainEntityOfPage($mainEntityOfPage); + public function makesOffer($makesOffer); public function member($member); @@ -74,6 +88,8 @@ public function members($members); public function naics($naics); + public function name($name); + public function numberOfEmployees($numberOfEmployees); public function offeredBy($offeredBy); @@ -82,12 +98,16 @@ public function owns($owns); public function parentOrganization($parentOrganization); + public function potentialAction($potentialAction); + public function publishingPrinciples($publishingPrinciples); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function seeks($seeks); public function serviceArea($serviceArea); @@ -98,34 +118,14 @@ public function sponsor($sponsor); public function subOrganization($subOrganization); + public function subjectOf($subjectOf); + public function taxID($taxID); public function telephone($telephone); - public function vatID($vatID); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - - public function subjectOf($subjectOf); - public function url($url); + public function vatID($vatID); + } diff --git a/src/Contracts/WriteActionContract.php b/src/Contracts/WriteActionContract.php index 2702afe2c..8a27497c8 100644 --- a/src/Contracts/WriteActionContract.php +++ b/src/Contracts/WriteActionContract.php @@ -4,54 +4,54 @@ interface WriteActionContract { - public function inLanguage($inLanguage); - - public function language($language); - public function actionStatus($actionStatus); - public function agent($agent); - - public function endTime($endTime); - - public function error($error); - - public function instrument($instrument); + public function additionalType($additionalType); - public function location($location); + public function agent($agent); - public function object($object); + public function alternateName($alternateName); - public function participant($participant); + public function description($description); - public function result($result); + public function disambiguatingDescription($disambiguatingDescription); - public function startTime($startTime); + public function endTime($endTime); - public function target($target); + public function error($error); - public function additionalType($additionalType); + public function identifier($identifier); - public function alternateName($alternateName); + public function image($image); - public function description($description); + public function inLanguage($inLanguage); - public function disambiguatingDescription($disambiguatingDescription); + public function instrument($instrument); - public function identifier($identifier); + public function language($language); - public function image($image); + public function location($location); public function mainEntityOfPage($mainEntityOfPage); public function name($name); + public function object($object); + + public function participant($participant); + public function potentialAction($potentialAction); + public function result($result); + public function sameAs($sameAs); + public function startTime($startTime); + public function subjectOf($subjectOf); + public function target($target); + public function url($url); } diff --git a/src/Contracts/ZooContract.php b/src/Contracts/ZooContract.php index 57b91b742..4cdc5e9b0 100644 --- a/src/Contracts/ZooContract.php +++ b/src/Contracts/ZooContract.php @@ -4,14 +4,16 @@ interface ZooContract { - public function openingHours($openingHours); - public function additionalProperty($additionalProperty); + public function additionalType($additionalType); + public function address($address); public function aggregateRating($aggregateRating); + public function alternateName($alternateName); + public function amenityFeature($amenityFeature); public function branchCode($branchCode); @@ -22,6 +24,10 @@ public function containedInPlace($containedInPlace); public function containsPlace($containsPlace); + public function description($description); + + public function disambiguatingDescription($disambiguatingDescription); + public function event($event); public function events($events); @@ -34,6 +40,10 @@ public function globalLocationNumber($globalLocationNumber); public function hasMap($hasMap); + public function identifier($identifier); + + public function image($image); + public function isAccessibleForFree($isAccessibleForFree); public function isicV4($isicV4); @@ -44,54 +54,44 @@ public function logo($logo); public function longitude($longitude); + public function mainEntityOfPage($mainEntityOfPage); + public function map($map); public function maps($maps); public function maximumAttendeeCapacity($maximumAttendeeCapacity); + public function name($name); + + public function openingHours($openingHours); + public function openingHoursSpecification($openingHoursSpecification); public function photo($photo); public function photos($photos); + public function potentialAction($potentialAction); + public function publicAccess($publicAccess); public function review($review); public function reviews($reviews); + public function sameAs($sameAs); + public function slogan($slogan); public function smokingAllowed($smokingAllowed); public function specialOpeningHoursSpecification($specialOpeningHoursSpecification); - public function telephone($telephone); - - public function additionalType($additionalType); - - public function alternateName($alternateName); - - public function description($description); - - public function disambiguatingDescription($disambiguatingDescription); - - public function identifier($identifier); - - public function image($image); - - public function mainEntityOfPage($mainEntityOfPage); - - public function name($name); - - public function potentialAction($potentialAction); - - public function sameAs($sameAs); - public function subjectOf($subjectOf); + public function telephone($telephone); + public function url($url); } diff --git a/src/ControlAction.php b/src/ControlAction.php index 0ff3dd130..0b074603c 100644 --- a/src/ControlAction.php +++ b/src/ControlAction.php @@ -28,340 +28,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ConvenienceStore.php b/src/ConvenienceStore.php index f50990f9c..284faad34 100644 --- a/src/ConvenienceStore.php +++ b/src/ConvenienceStore.php @@ -17,126 +17,104 @@ class ConvenienceStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Conversation.php b/src/Conversation.php index 08a80a7a9..423d74663 100644 --- a/src/Conversation.php +++ b/src/Conversation.php @@ -159,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -174,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -465,6 +498,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -690,6 +754,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -887,6 +984,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -917,6 +1030,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -947,6 +1074,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1088,6 +1230,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1170,6 +1328,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1291,6 +1463,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1334,190 +1520,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/CookAction.php b/src/CookAction.php index cb8fe51d6..60512388f 100644 --- a/src/CookAction.php +++ b/src/CookAction.php @@ -15,77 +15,96 @@ class CookAction extends BaseType implements CreateActionContract, ActionContract, ThingContract { /** - * A sub property of location. The specific food establishment where the - * action occurred. + * Indicates the current disposition of the Action. * - * @param FoodEstablishment|FoodEstablishment[]|Place|Place[] $foodEstablishment + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/foodEstablishment + * @see http://schema.org/actionStatus */ - public function foodEstablishment($foodEstablishment) + public function actionStatus($actionStatus) { - return $this->setProperty('foodEstablishment', $foodEstablishment); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The specific food event where the action - * occurred. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param FoodEvent|FoodEvent[] $foodEvent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/foodEvent + * @see http://schema.org/additionalType */ - public function foodEvent($foodEvent) + public function additionalType($additionalType) { - return $this->setProperty('foodEvent', $foodEvent); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of instrument. The recipe/instructions used to perform the - * action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Recipe|Recipe[] $recipe + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/recipe + * @see http://schema.org/agent */ - public function recipe($recipe) + public function agent($agent) { - return $this->setProperty('recipe', $recipe); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -126,288 +145,269 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * A sub property of location. The specific food establishment where the + * action occurred. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param FoodEstablishment|FoodEstablishment[]|Place|Place[] $foodEstablishment * * @return static * - * @see http://schema.org/location + * @see http://schema.org/foodEstablishment */ - public function location($location) + public function foodEstablishment($foodEstablishment) { - return $this->setProperty('location', $location); + return $this->setProperty('foodEstablishment', $foodEstablishment); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The specific food event where the action + * occurred. * - * @param Thing|Thing[] $object + * @param FoodEvent|FoodEvent[] $foodEvent * * @return static * - * @see http://schema.org/object + * @see http://schema.org/foodEvent */ - public function object($object) + public function foodEvent($foodEvent) { - return $this->setProperty('object', $object); + return $this->setProperty('foodEvent', $foodEvent); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of instrument. The recipe/instructions used to perform the + * action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Recipe|Recipe[] $recipe * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipe */ - public function image($image) + public function recipe($recipe) { - return $this->setProperty('image', $image); + return $this->setProperty('recipe', $recipe); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Corporation.php b/src/Corporation.php index 6d1d543af..3d5469313 100644 --- a/src/Corporation.php +++ b/src/Corporation.php @@ -14,21 +14,22 @@ class Corporation extends BaseType implements OrganizationContract, ThingContract { /** - * The exchange traded instrument associated with a Corporation object. The - * tickerSymbol is expressed as an exchange and an instrument name separated - * by a space character. For the exchange component of the tickerSymbol - * attribute, we recommend using the controlled vocabulary of Market - * Identifier Codes (MIC) specified in ISO15022. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $tickerSymbol + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/tickerSymbol + * @see http://schema.org/additionalType */ - public function tickerSymbol($tickerSymbol) + public function additionalType($additionalType) { - return $this->setProperty('tickerSymbol', $tickerSymbol); + return $this->setProperty('additionalType', $additionalType); } /** @@ -60,6 +61,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -162,6 +177,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -393,6 +439,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -467,6 +546,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -540,6 +635,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -597,6 +706,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -649,6 +773,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -724,6 +864,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -754,203 +908,49 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * The exchange traded instrument associated with a Corporation object. The + * tickerSymbol is expressed as an exchange and an instrument name separated + * by a space character. For the exchange component of the tickerSymbol + * attribute, we recommend using the controlled vocabulary of Market + * Identifier Codes (MIC) specified in ISO15022. * - * @param string|string[] $sameAs + * @param string|string[] $tickerSymbol * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/tickerSymbol */ - public function sameAs($sameAs) + public function tickerSymbol($tickerSymbol) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('tickerSymbol', $tickerSymbol); } /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Country.php b/src/Country.php index 67a2ad955..39c5dd07c 100644 --- a/src/Country.php +++ b/src/Country.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Course.php b/src/Course.php index bce3cf9a6..0806dfc72 100644 --- a/src/Course.php +++ b/src/Course.php @@ -18,53 +18,6 @@ */ class Course extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The identifier for the [[Course]] used by the course [[provider]] (e.g. - * CS101 or 6.001). - * - * @param string|string[] $courseCode - * - * @return static - * - * @see http://schema.org/courseCode - */ - public function courseCode($courseCode) - { - return $this->setProperty('courseCode', $courseCode); - } - - /** - * Requirements for taking the Course. May be completion of another - * [[Course]] or a textual description like "permission of instructor". - * Requirements may be a pre-requisite competency, referenced using - * [[AlignmentObject]]. - * - * @param AlignmentObject|AlignmentObject[]|Course|Course[]|string|string[] $coursePrerequisites - * - * @return static - * - * @see http://schema.org/coursePrerequisites - */ - public function coursePrerequisites($coursePrerequisites) - { - return $this->setProperty('coursePrerequisites', $coursePrerequisites); - } - - /** - * An offering of the course at a specific time and place or through - * specific media or mode of study or to a specific section of students. - * - * @param CourseInstance|CourseInstance[] $hasCourseInstance - * - * @return static - * - * @see http://schema.org/hasCourseInstance - */ - public function hasCourseInstance($hasCourseInstance) - { - return $this->setProperty('hasCourseInstance', $hasCourseInstance); - } - /** * The subject matter of the content. * @@ -209,6 +162,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -224,6 +196,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -456,6 +442,38 @@ public function copyrightYear($copyrightYear) return $this->setProperty('copyrightYear', $copyrightYear); } + /** + * The identifier for the [[Course]] used by the course [[provider]] (e.g. + * CS101 or 6.001). + * + * @param string|string[] $courseCode + * + * @return static + * + * @see http://schema.org/courseCode + */ + public function courseCode($courseCode) + { + return $this->setProperty('courseCode', $courseCode); + } + + /** + * Requirements for taking the Course. May be completion of another + * [[Course]] or a textual description like "permission of instructor". + * Requirements may be a pre-requisite competency, referenced using + * [[AlignmentObject]]. + * + * @param AlignmentObject|AlignmentObject[]|Course|Course[]|string|string[] $coursePrerequisites + * + * @return static + * + * @see http://schema.org/coursePrerequisites + */ + public function coursePrerequisites($coursePrerequisites) + { + return $this->setProperty('coursePrerequisites', $coursePrerequisites); + } + /** * The creator/author of this CreativeWork. This is the same as the Author * property for CreativeWork. @@ -515,6 +533,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -711,6 +760,21 @@ public function genre($genre) return $this->setProperty('genre', $genre); } + /** + * An offering of the course at a specific time and place or through + * specific media or mode of study or to a specific section of students. + * + * @param CourseInstance|CourseInstance[] $hasCourseInstance + * + * @return static + * + * @see http://schema.org/hasCourseInstance + */ + public function hasCourseInstance($hasCourseInstance) + { + return $this->setProperty('hasCourseInstance', $hasCourseInstance); + } + /** * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). @@ -740,6 +804,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -937,6 +1034,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -967,6 +1080,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -997,6 +1124,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1138,6 +1280,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1220,6 +1378,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1341,6 +1513,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1384,190 +1570,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/CourseInstance.php b/src/CourseInstance.php index 7e9d84e8c..53bd07dce 100644 --- a/src/CourseInstance.php +++ b/src/CourseInstance.php @@ -15,39 +15,6 @@ */ class CourseInstance extends BaseType implements EventContract, ThingContract { - /** - * The medium or means of delivery of the course instance or the mode of - * study, either as a text label (e.g. "online", "onsite" or "blended"; - * "synchronous" or "asynchronous"; "full-time" or "part-time") or as a URL - * reference to a term from a controlled vocabulary (e.g. - * https://ceds.ed.gov/element/001311#Asynchronous ). - * - * @param string|string[] $courseMode - * - * @return static - * - * @see http://schema.org/courseMode - */ - public function courseMode($courseMode) - { - return $this->setProperty('courseMode', $courseMode); - } - - /** - * A person assigned to instruct or provide instructional assistance for the - * [[CourseInstance]]. - * - * @param Person|Person[] $instructor - * - * @return static - * - * @see http://schema.org/instructor - */ - public function instructor($instructor) - { - return $this->setProperty('instructor', $instructor); - } - /** * The subject matter of the content. * @@ -78,6 +45,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -93,6 +79,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -164,6 +164,38 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * The medium or means of delivery of the course instance or the mode of + * study, either as a text label (e.g. "online", "onsite" or "blended"; + * "synchronous" or "asynchronous"; "full-time" or "part-time") or as a URL + * reference to a term from a controlled vocabulary (e.g. + * https://ceds.ed.gov/element/001311#Asynchronous ). + * + * @param string|string[] $courseMode + * + * @return static + * + * @see http://schema.org/courseMode + */ + public function courseMode($courseMode) + { + return $this->setProperty('courseMode', $courseMode); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -180,6 +212,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -254,6 +303,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -271,6 +353,21 @@ public function inLanguage($inLanguage) return $this->setProperty('inLanguage', $inLanguage); } + /** + * A person assigned to instruct or provide instructional assistance for the + * [[CourseInstance]]. + * + * @param Person|Person[] $instructor + * + * @return static + * + * @see http://schema.org/instructor + */ + public function instructor($instructor) + { + return $this->setProperty('instructor', $instructor); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -300,6 +397,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -314,6 +427,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -374,6 +501,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -434,6 +576,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -496,6 +654,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -542,6 +714,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -573,190 +759,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Courthouse.php b/src/Courthouse.php index 8326010cd..a33e73903 100644 --- a/src/Courthouse.php +++ b/src/Courthouse.php @@ -15,35 +15,6 @@ */ class Courthouse extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/CreateAction.php b/src/CreateAction.php index 3c8be13f1..a70154e0f 100644 --- a/src/CreateAction.php +++ b/src/CreateAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/CreativeWork.php b/src/CreativeWork.php index b56aca418..1a93a91ce 100644 --- a/src/CreativeWork.php +++ b/src/CreativeWork.php @@ -157,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -172,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -463,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -688,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -885,6 +982,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -915,6 +1028,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -945,6 +1072,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1086,6 +1228,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1168,6 +1326,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1289,6 +1461,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1332,190 +1518,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/CreativeWorkSeason.php b/src/CreativeWorkSeason.php index 890bc6455..0a12ecc43 100644 --- a/src/CreativeWorkSeason.php +++ b/src/CreativeWorkSeason.php @@ -13,167 +13,6 @@ */ class CreativeWorkSeason extends BaseType implements CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * An episode of a tv, radio or game media within a series or season. - * - * @param Episode|Episode[] $episode - * - * @return static - * - * @see http://schema.org/episode - */ - public function episode($episode) - { - return $this->setProperty('episode', $episode); - } - - /** - * An episode of a TV/radio series or season. - * - * @param Episode|Episode[] $episodes - * - * @return static - * - * @see http://schema.org/episodes - */ - public function episodes($episodes) - { - return $this->setProperty('episodes', $episodes); - } - - /** - * The number of episodes in this season or series. - * - * @param int|int[] $numberOfEpisodes - * - * @return static - * - * @see http://schema.org/numberOfEpisodes - */ - public function numberOfEpisodes($numberOfEpisodes) - { - return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * Position of the season within an ordered group of seasons. - * - * @param int|int[]|string|string[] $seasonNumber - * - * @return static - * - * @see http://schema.org/seasonNumber - */ - public function seasonNumber($seasonNumber) - { - return $this->setProperty('seasonNumber', $seasonNumber); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - - /** - * The trailer of a movie or tv/radio series, season, episode, etc. - * - * @param VideoObject|VideoObject[] $trailer - * - * @return static - * - * @see http://schema.org/trailer - */ - public function trailer($trailer) - { - return $this->setProperty('trailer', $trailer); - } - /** * The subject matter of the content. * @@ -318,6 +157,41 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -333,6 +207,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -625,60 +513,107 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * 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. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/disambiguatingDescription */ - public function educationalAlignment($educationalAlignment) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * A link to the page containing the comments of the CreativeWork. * - * @param string|string[] $educationalUse + * @param string|string[] $discussionUrl * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/discussionUrl */ - public function educationalUse($educationalUse) + public function discussionUrl($discussionUrl) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); } /** @@ -737,6 +672,49 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An episode of a tv, radio or game media within a series or season. + * + * @param Episode|Episode[] $episode + * + * @return static + * + * @see http://schema.org/episode + */ + public function episode($episode) + { + return $this->setProperty('episode', $episode); + } + + /** + * An episode of a TV/radio series or season. + * + * @param Episode|Episode[] $episodes + * + * @return static + * + * @see http://schema.org/episodes + */ + public function episodes($episodes) + { + return $this->setProperty('episodes', $episodes); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -849,6 +827,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1046,6 +1057,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1076,6 +1103,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of episodes in this season or series. + * + * @param int|int[] $numberOfEpisodes + * + * @return static + * + * @see http://schema.org/numberOfEpisodes + */ + public function numberOfEpisodes($numberOfEpisodes) + { + return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1092,6 +1147,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1106,6 +1175,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1121,6 +1205,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1247,6 +1346,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1264,6 +1379,20 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * Position of the season within an ordered group of seasons. + * + * @param int|int[]|string|string[] $seasonNumber + * + * @return static + * + * @see http://schema.org/seasonNumber + */ + public function seasonNumber($seasonNumber) + { + return $this->setProperty('seasonNumber', $seasonNumber); + } + /** * The Organization on whose behalf the creator was working. * @@ -1329,6 +1458,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1420,6 +1578,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1450,6 +1622,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1493,190 +1679,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/CreativeWorkSeries.php b/src/CreativeWorkSeries.php index a8f210866..b18d1ac6e 100644 --- a/src/CreativeWorkSeries.php +++ b/src/CreativeWorkSeries.php @@ -31,52 +31,6 @@ */ class CreativeWorkSeries extends BaseType implements CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - /** * The subject matter of the content. * @@ -221,6 +175,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -236,6 +209,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -527,6 +514,53 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -640,6 +674,21 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -752,6 +801,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -874,6 +956,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -949,6 +1047,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -979,6 +1093,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1009,6 +1137,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1150,6 +1293,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1232,6 +1391,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1353,6 +1541,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1396,206 +1598,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - } diff --git a/src/CreditCard.php b/src/CreditCard.php index 5e8b3c854..4d5009369 100644 --- a/src/CreditCard.php +++ b/src/CreditCard.php @@ -29,65 +29,82 @@ class CreditCard extends BaseType implements PaymentCardContract, LoanOrCreditContract, FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/additionalType */ - public function annualPercentageRate($annualPercentageRate) + public function additionalType($additionalType) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('additionalType', $additionalType); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/aggregateRating */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function aggregateRating($aggregateRating) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/alternateName */ - public function interestRate($interestRate) + public function alternateName($alternateName) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The amount of money. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amount */ - public function aggregateRating($aggregateRating) + public function amount($amount) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amount', $amount); + } + + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -195,451 +212,434 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * The hours during which this service or contact is available. + * A description of the item. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $description * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/description */ - public function hoursAvailable($hoursAvailable) + public function description($description) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('description', $description); } /** - * A pointer to another, somehow related product (or multiple products). + * 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. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/disambiguatingDescription */ - public function isRelatedTo($isRelatedTo) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param string|string[] $feesAndCommissionsSpecification * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/feesAndCommissionsSpecification */ - public function isSimilarTo($isSimilarTo) + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * The hours during which this service or contact is available. * - * @param Offer|Offer[] $offers + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/hoursAvailable */ - public function offers($offers) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('offers', $offers); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $produces + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/identifier */ - public function produces($produces) + public function identifier($identifier) { - return $this->setProperty('produces', $produces); + return $this->setProperty('identifier', $identifier); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/image */ - public function provider($provider) + public function image($image) { - return $this->setProperty('provider', $provider); + return $this->setProperty('image', $image); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param string|string[] $providerMobility + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/interestRate */ - public function providerMobility($providerMobility) + public function interestRate($interestRate) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('interestRate', $interestRate); } /** - * A review of the item. + * A pointer to another, somehow related product (or multiple products). * - * @param Review|Review[] $review + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/isRelatedTo */ - public function review($review) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('review', $review); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * The geographic area where the service is provided. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/isSimilarTo */ - public function serviceArea($serviceArea) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * The audience eligible for this service. + * The duration of the loan or credit agreement. * - * @param Audience|Audience[] $serviceAudience + * @param QuantitativeValue|QuantitativeValue[] $loanTerm * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/loanTerm */ - public function serviceAudience($serviceAudience) + public function loanTerm($loanTerm) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('loanTerm', $loanTerm); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An associated logo. * - * @param Thing|Thing[] $serviceOutput + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/logo */ - public function serviceOutput($serviceOutput) + public function logo($logo) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('logo', $logo); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $serviceType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/mainEntityOfPage */ - public function serviceType($serviceType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A slogan or motto associated with the item. + * The name of the item. * - * @param string|string[] $slogan + * @param string|string[] $name * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/name */ - public function slogan($slogan) + public function name($name) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param string|string[] $additionalType + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/offers */ - public function additionalType($additionalType) + public function offers($offers) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('offers', $offers); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $description + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/description + * @see http://schema.org/produces */ - public function description($description) + public function produces($produces) { - return $this->setProperty('description', $description); + return $this->setProperty('produces', $produces); } /** - * 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. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/provider */ - public function disambiguatingDescription($disambiguatingDescription) + public function provider($provider) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('provider', $provider); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/providerMobility */ - public function identifier($identifier) + public function providerMobility($providerMobility) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('providerMobility', $providerMobility); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Assets required to secure loan or credit repayments. It may take form of + * third party pledge, goods, financial instruments (cash, securities, etc.) * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[]|string|string[] $requiredCollateral * * @return static * - * @see http://schema.org/image + * @see http://schema.org/requiredCollateral */ - public function image($image) + public function requiredCollateral($requiredCollateral) { - return $this->setProperty('image', $image); + return $this->setProperty('requiredCollateral', $requiredCollateral); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A review of the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/review */ - public function mainEntityOfPage($mainEntityOfPage) + public function review($review) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('review', $review); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The geographic area where the service is provided. * - * @param Action|Action[] $potentialAction + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceArea */ - public function potentialAction($potentialAction) + public function serviceArea($serviceArea) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceArea', $serviceArea); } /** - * 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. + * The audience eligible for this service. * - * @param string|string[] $sameAs + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/serviceAudience */ - public function sameAs($sameAs) + public function serviceAudience($serviceAudience) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * A CreativeWork or Event about this Thing. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/serviceOutput */ - public function subjectOf($subjectOf) + public function serviceOutput($serviceOutput) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * URL of the item. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param string|string[] $url + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/url + * @see http://schema.org/serviceType */ - public function url($url) + public function serviceType($serviceType) { - return $this->setProperty('url', $url); + return $this->setProperty('serviceType', $serviceType); } /** - * The amount of money. + * A slogan or motto associated with the item. * - * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/amount + * @see http://schema.org/slogan */ - public function amount($amount) + public function slogan($slogan) { - return $this->setProperty('amount', $amount); + return $this->setProperty('slogan', $slogan); } /** - * The duration of the loan or credit agreement. + * A CreativeWork or Event about this Thing. * - * @param QuantitativeValue|QuantitativeValue[] $loanTerm + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/loanTerm + * @see http://schema.org/subjectOf */ - public function loanTerm($loanTerm) + public function subjectOf($subjectOf) { - return $this->setProperty('loanTerm', $loanTerm); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Assets required to secure loan or credit repayments. It may take form of - * third party pledge, goods, financial instruments (cash, securities, etc.) + * URL of the item. * - * @param Thing|Thing[]|string|string[] $requiredCollateral + * @param string|string[] $url * * @return static * - * @see http://schema.org/requiredCollateral + * @see http://schema.org/url */ - public function requiredCollateral($requiredCollateral) + public function url($url) { - return $this->setProperty('requiredCollateral', $requiredCollateral); + return $this->setProperty('url', $url); } } diff --git a/src/Crematorium.php b/src/Crematorium.php index d44fed7c7..ff4a46ae1 100644 --- a/src/Crematorium.php +++ b/src/Crematorium.php @@ -14,35 +14,6 @@ */ class Crematorium extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/CurrencyConversionService.php b/src/CurrencyConversionService.php index 7c393f43d..7a5742ee2 100644 --- a/src/CurrencyConversionService.php +++ b/src/CurrencyConversionService.php @@ -16,65 +16,68 @@ class CurrencyConversionService extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/additionalType */ - public function annualPercentageRate($annualPercentageRate) + public function additionalType($additionalType) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('additionalType', $additionalType); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/aggregateRating */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function aggregateRating($aggregateRating) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/alternateName */ - public function interestRate($interestRate) + public function alternateName($alternateName) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/annualPercentageRate */ - public function aggregateRating($aggregateRating) + public function annualPercentageRate($annualPercentageRate) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -182,380 +185,377 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * A description of the item. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/description */ - public function hasOfferCatalog($hasOfferCatalog) + public function description($description) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('description', $description); } /** - * The hours during which this service or contact is available. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/disambiguatingDescription */ - public function hoursAvailable($hoursAvailable) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, somehow related product (or multiple products). + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param string|string[] $feesAndCommissionsSpecification * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/feesAndCommissionsSpecification */ - public function isRelatedTo($isRelatedTo) + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/hasOfferCatalog */ - public function isSimilarTo($isSimilarTo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An associated logo. + * The hours during which this service or contact is available. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hoursAvailable */ - public function logo($logo) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $offers + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/identifier */ - public function offers($offers) + public function identifier($identifier) { - return $this->setProperty('offers', $offers); + return $this->setProperty('identifier', $identifier); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $produces + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/image */ - public function produces($produces) + public function image($image) { - return $this->setProperty('produces', $produces); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/interestRate */ - public function provider($provider) + public function interestRate($interestRate) { - return $this->setProperty('provider', $provider); + return $this->setProperty('interestRate', $interestRate); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * A pointer to another, somehow related product (or multiple products). * - * @param string|string[] $providerMobility + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/isRelatedTo */ - public function providerMobility($providerMobility) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * A review of the item. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param Review|Review[] $review + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/isSimilarTo */ - public function review($review) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('review', $review); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * The geographic area where the service is provided. + * An associated logo. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/logo */ - public function serviceArea($serviceArea) + public function logo($logo) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('logo', $logo); } /** - * The audience eligible for this service. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Audience|Audience[] $serviceAudience + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/mainEntityOfPage */ - public function serviceAudience($serviceAudience) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * The name of the item. * - * @param Thing|Thing[] $serviceOutput + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/name */ - public function serviceOutput($serviceOutput) + public function name($name) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('name', $name); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param string|string[] $serviceType + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/offers */ - public function serviceType($serviceType) + public function offers($offers) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('offers', $offers); } /** - * A slogan or motto associated with the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $slogan + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/potentialAction */ - public function slogan($slogan) + public function potentialAction($potentialAction) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/produces */ - public function additionalType($additionalType) + public function produces($produces) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('produces', $produces); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $description + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/description + * @see http://schema.org/providerMobility */ - public function description($description) + public function providerMobility($providerMobility) { - return $this->setProperty('description', $description); + return $this->setProperty('providerMobility', $providerMobility); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** diff --git a/src/DanceEvent.php b/src/DanceEvent.php index bfbf4923d..8e22fbce4 100644 --- a/src/DanceEvent.php +++ b/src/DanceEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/DanceGroup.php b/src/DanceGroup.php index 7f21e8cec..360063000 100644 --- a/src/DanceGroup.php +++ b/src/DanceGroup.php @@ -15,6 +15,25 @@ */ class DanceGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -44,6 +63,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -146,6 +179,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -377,6 +441,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -451,6 +548,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -524,6 +637,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -581,6 +708,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -633,6 +775,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -708,6 +866,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -738,203 +910,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/DataCatalog.php b/src/DataCatalog.php index eda13ac3a..65407e1ab 100644 --- a/src/DataCatalog.php +++ b/src/DataCatalog.php @@ -13,20 +13,6 @@ */ class DataCatalog extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A dataset contained in this catalog. - * - * @param Dataset|Dataset[] $dataset - * - * @return static - * - * @see http://schema.org/dataset - */ - public function dataset($dataset) - { - return $this->setProperty('dataset', $dataset); - } - /** * The subject matter of the content. * @@ -171,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -186,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -433,6 +452,20 @@ public function creator($creator) return $this->setProperty('creator', $creator); } + /** + * A dataset contained in this catalog. + * + * @param Dataset|Dataset[] $dataset + * + * @return static + * + * @see http://schema.org/dataset + */ + public function dataset($dataset) + { + return $this->setProperty('dataset', $dataset); + } + /** * The date on which the CreativeWork was created or the item was added to a * DataFeed. @@ -477,6 +510,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -702,6 +766,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -899,6 +996,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -929,6 +1042,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -959,6 +1086,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1100,6 +1242,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1182,6 +1340,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1303,6 +1475,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1346,190 +1532,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/DataDownload.php b/src/DataDownload.php index 85d7bf5d7..729a82215 100644 --- a/src/DataDownload.php +++ b/src/DataDownload.php @@ -14,284 +14,6 @@ */ class DataDownload extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { - /** - * A NewsArticle associated with the Media Object. - * - * @param NewsArticle|NewsArticle[] $associatedArticle - * - * @return static - * - * @see http://schema.org/associatedArticle - */ - public function associatedArticle($associatedArticle) - { - return $this->setProperty('associatedArticle', $associatedArticle); - } - - /** - * The bitrate of the media object. - * - * @param string|string[] $bitrate - * - * @return static - * - * @see http://schema.org/bitrate - */ - public function bitrate($bitrate) - { - return $this->setProperty('bitrate', $bitrate); - } - - /** - * File size in (mega/kilo) bytes. - * - * @param string|string[] $contentSize - * - * @return static - * - * @see http://schema.org/contentSize - */ - public function contentSize($contentSize) - { - return $this->setProperty('contentSize', $contentSize); - } - - /** - * Actual bytes of the media object, for example the image file or video - * file. - * - * @param string|string[] $contentUrl - * - * @return static - * - * @see http://schema.org/contentUrl - */ - public function contentUrl($contentUrl) - { - return $this->setProperty('contentUrl', $contentUrl); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * A URL pointing to a player for a specific video. In general, this is the - * information in the ```src``` element of an ```embed``` tag and should not - * be the same as the content of the ```loc``` tag. - * - * @param string|string[] $embedUrl - * - * @return static - * - * @see http://schema.org/embedUrl - */ - public function embedUrl($embedUrl) - { - return $this->setProperty('embedUrl', $embedUrl); - } - - /** - * The CreativeWork encoded by this media object. - * - * @param CreativeWork|CreativeWork[] $encodesCreativeWork - * - * @return static - * - * @see http://schema.org/encodesCreativeWork - */ - public function encodesCreativeWork($encodesCreativeWork) - { - return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); - } - - /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside - * particular [[encodingFormat]] information. - * - * Unregistered or niche encoding and file formats can be indicated instead - * via the most appropriate URL, e.g. defining Web page or a - * Wikipedia/Wikidata entry. - * - * @param string|string[] $encodingFormat - * - * @return static - * - * @see http://schema.org/encodingFormat - */ - public function encodingFormat($encodingFormat) - { - return $this->setProperty('encodingFormat', $encodingFormat); - } - - /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime - * - * @return static - * - * @see http://schema.org/endTime - */ - public function endTime($endTime) - { - return $this->setProperty('endTime', $endTime); - } - - /** - * The height of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height - * - * @return static - * - * @see http://schema.org/height - */ - public function height($height) - { - return $this->setProperty('height', $height); - } - - /** - * Player type required—for example, Flash or Silverlight. - * - * @param string|string[] $playerType - * - * @return static - * - * @see http://schema.org/playerType - */ - public function playerType($playerType) - { - return $this->setProperty('playerType', $playerType); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The regions where the media is allowed. If not specified, then it's - * assumed to be allowed everywhere. Specify the countries in [ISO 3166 - * format](http://en.wikipedia.org/wiki/ISO_3166). - * - * @param Place|Place[] $regionsAllowed - * - * @return static - * - * @see http://schema.org/regionsAllowed - */ - public function regionsAllowed($regionsAllowed) - { - return $this->setProperty('regionsAllowed', $regionsAllowed); - } - - /** - * Indicates if use of the media require a subscription (either paid or - * free). Allowed values are ```true``` or ```false``` (note that an earlier - * version had 'yes', 'no'). - * - * @param bool|bool[] $requiresSubscription - * - * @return static - * - * @see http://schema.org/requiresSubscription - */ - public function requiresSubscription($requiresSubscription) - { - return $this->setProperty('requiresSubscription', $requiresSubscription); - } - - /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime - * - * @return static - * - * @see http://schema.org/startTime - */ - public function startTime($startTime) - { - return $this->setProperty('startTime', $startTime); - } - - /** - * Date when this media object was uploaded to this site. - * - * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate - * - * @return static - * - * @see http://schema.org/uploadDate - */ - public function uploadDate($uploadDate) - { - return $this->setProperty('uploadDate', $uploadDate); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - /** * The subject matter of the content. * @@ -436,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -451,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -465,6 +220,20 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -552,6 +321,20 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + /** * Fictional person connected with a creative work. * @@ -640,6 +423,35 @@ public function contentRating($contentRating) return $this->setProperty('contentRating', $contentRating); } + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + /** * A secondary contributor to the CreativeWork or Event. * @@ -742,18 +554,64 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * - * @param string|string[] $discussionUrl + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/duration */ - public function discussionUrl($discussionUrl) + public function duration($duration) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('duration', $duration); } /** @@ -799,6 +657,36 @@ public function educationalUse($educationalUse) return $this->setProperty('educationalUse', $educationalUse); } + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for associatedMedia. @@ -814,6 +702,33 @@ public function encoding($encoding) return $this->setProperty('encoding', $encoding); } + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + /** * A media object that encodes this CreativeWork. * @@ -828,6 +743,29 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -940,6 +878,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1137,6 +1122,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1167,6 +1168,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1183,6 +1198,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + /** * The position of an item in a series or sequence of items. * @@ -1197,6 +1226,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1212,6 +1256,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1295,6 +1354,22 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1310,6 +1385,22 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + /** * A review of the item. * @@ -1325,17 +1416,33 @@ public function review($review) } /** - * Review of the item. + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * 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. * - * @param Review|Review[] $reviews + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/sameAs */ - public function reviews($reviews) + public function sameAs($sameAs) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('sameAs', $sameAs); } /** @@ -1420,6 +1527,43 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1542,232 +1686,88 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Date when this media object was uploaded to this site. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/uploadDate */ - public function mainEntityOfPage($mainEntityOfPage) + public function uploadDate($uploadDate) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('uploadDate', $uploadDate); } /** - * The name of the item. + * URL of the item. * - * @param string|string[] $name + * @param string|string[] $url * * @return static * - * @see http://schema.org/name + * @see http://schema.org/url */ - public function name($name) + public function url($url) { - return $this->setProperty('name', $name); + return $this->setProperty('url', $url); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The version of the CreativeWork embodied by a specified resource. * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/version */ - public function potentialAction($potentialAction) + public function version($version) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('version', $version); } /** - * 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. + * An embedded video object. * - * @param string|string[] $sameAs + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/video */ - public function sameAs($sameAs) + public function video($video) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('video', $video); } /** - * A CreativeWork or Event about this Thing. + * The width of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/width */ - public function subjectOf($subjectOf) + public function width($width) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('width', $width); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/DataFeed.php b/src/DataFeed.php index 57cdd7870..48e3ba84d 100644 --- a/src/DataFeed.php +++ b/src/DataFeed.php @@ -15,109 +15,6 @@ */ class DataFeed extends BaseType implements DatasetContract, CreativeWorkContract, ThingContract { - /** - * An item within in a data feed. Data feeds may have many elements. - * - * @param DataFeedItem|DataFeedItem[]|Thing|Thing[]|string|string[] $dataFeedElement - * - * @return static - * - * @see http://schema.org/dataFeedElement - */ - public function dataFeedElement($dataFeedElement) - { - return $this->setProperty('dataFeedElement', $dataFeedElement); - } - - /** - * A data catalog which contains this dataset. - * - * @param DataCatalog|DataCatalog[] $catalog - * - * @return static - * - * @see http://schema.org/catalog - */ - public function catalog($catalog) - { - return $this->setProperty('catalog', $catalog); - } - - /** - * The range of temporal applicability of a dataset, e.g. for a 2011 census - * dataset, the year 2011 (in ISO 8601 time interval format). - * - * @param \DateTimeInterface|\DateTimeInterface[] $datasetTimeInterval - * - * @return static - * - * @see http://schema.org/datasetTimeInterval - */ - public function datasetTimeInterval($datasetTimeInterval) - { - return $this->setProperty('datasetTimeInterval', $datasetTimeInterval); - } - - /** - * A downloadable form of this dataset, at a specific location, in a - * specific format. - * - * @param DataDownload|DataDownload[] $distribution - * - * @return static - * - * @see http://schema.org/distribution - */ - public function distribution($distribution) - { - return $this->setProperty('distribution', $distribution); - } - - /** - * A data catalog which contains this dataset (this property was previously - * 'catalog', preferred name is now 'includedInDataCatalog'). - * - * @param DataCatalog|DataCatalog[] $includedDataCatalog - * - * @return static - * - * @see http://schema.org/includedDataCatalog - */ - public function includedDataCatalog($includedDataCatalog) - { - return $this->setProperty('includedDataCatalog', $includedDataCatalog); - } - - /** - * A data catalog which contains this dataset. - * - * @param DataCatalog|DataCatalog[] $includedInDataCatalog - * - * @return static - * - * @see http://schema.org/includedInDataCatalog - */ - public function includedInDataCatalog($includedInDataCatalog) - { - return $this->setProperty('includedInDataCatalog', $includedInDataCatalog); - } - - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - /** * The subject matter of the content. * @@ -262,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -277,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -378,6 +308,20 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A data catalog which contains this dataset. + * + * @param DataCatalog|DataCatalog[] $catalog + * + * @return static + * + * @see http://schema.org/catalog + */ + public function catalog($catalog) + { + return $this->setProperty('catalog', $catalog); + } + /** * Fictional person connected with a creative work. * @@ -524,6 +468,35 @@ public function creator($creator) return $this->setProperty('creator', $creator); } + /** + * An item within in a data feed. Data feeds may have many elements. + * + * @param DataFeedItem|DataFeedItem[]|Thing|Thing[]|string|string[] $dataFeedElement + * + * @return static + * + * @see http://schema.org/dataFeedElement + */ + public function dataFeedElement($dataFeedElement) + { + return $this->setProperty('dataFeedElement', $dataFeedElement); + } + + /** + * The range of temporal applicability of a dataset, e.g. for a 2011 census + * dataset, the year 2011 (in ISO 8601 time interval format). + * + * @param \DateTimeInterface|\DateTimeInterface[] $datasetTimeInterval + * + * @return static + * + * @see http://schema.org/datasetTimeInterval + */ + public function datasetTimeInterval($datasetTimeInterval) + { + return $this->setProperty('datasetTimeInterval', $datasetTimeInterval); + } + /** * The date on which the CreativeWork was created or the item was added to a * DataFeed. @@ -568,6 +541,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -582,6 +586,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * A downloadable form of this dataset, at a specific location, in a + * specific format. + * + * @param DataDownload|DataDownload[] $distribution + * + * @return static + * + * @see http://schema.org/distribution + */ + public function distribution($distribution) + { + return $this->setProperty('distribution', $distribution); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -794,40 +813,102 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Language|Language[]|string|string[] $inLanguage + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/identifier */ - public function inLanguage($inLanguage) + public function identifier($identifier) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('identifier', $identifier); } /** - * The number of interactions for the CreativeWork using the WebSite or - * SoftwareApplication. The most specific child type of InteractionCounter - * should be used. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/interactionStatistic + * @see http://schema.org/image */ - public function interactionStatistic($interactionStatistic) + public function image($image) { - return $this->setProperty('interactionStatistic', $interactionStatistic); + return $this->setProperty('image', $image); } /** - * The predominant mode of learning supported by the learning resource. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A data catalog which contains this dataset (this property was previously + * 'catalog', preferred name is now 'includedInDataCatalog'). + * + * @param DataCatalog|DataCatalog[] $includedDataCatalog + * + * @return static + * + * @see http://schema.org/includedDataCatalog + */ + public function includedDataCatalog($includedDataCatalog) + { + return $this->setProperty('includedDataCatalog', $includedDataCatalog); + } + + /** + * A data catalog which contains this dataset. + * + * @param DataCatalog|DataCatalog[] $includedInDataCatalog + * + * @return static + * + * @see http://schema.org/includedInDataCatalog + */ + public function includedInDataCatalog($includedInDataCatalog) + { + return $this->setProperty('includedInDataCatalog', $includedInDataCatalog); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. * Acceptable values are 'active', 'expositive', or 'mixed'. * * @param string|string[] $interactivityType @@ -915,6 +996,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -990,6 +1087,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1020,6 +1133,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1050,6 +1177,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1191,6 +1333,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1273,6 +1431,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1394,6 +1566,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1437,190 +1623,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/DataFeedItem.php b/src/DataFeedItem.php index e3c2a06c3..1b8ef49d9 100644 --- a/src/DataFeedItem.php +++ b/src/DataFeedItem.php @@ -14,95 +14,80 @@ class DataFeedItem extends BaseType implements IntangibleContract, ThingContract { /** - * The date on which the CreativeWork was created or the item was added to a - * DataFeed. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated - * - * @return static - * - * @see http://schema.org/dateCreated - */ - public function dateCreated($dateCreated) - { - return $this->setProperty('dateCreated', $dateCreated); - } - - /** - * The datetime the item was removed from the DataFeed. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param \DateTimeInterface|\DateTimeInterface[] $dateDeleted + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/dateDeleted + * @see http://schema.org/additionalType */ - public function dateDeleted($dateDeleted) + public function additionalType($additionalType) { - return $this->setProperty('dateDeleted', $dateDeleted); + return $this->setProperty('additionalType', $additionalType); } /** - * The date on which the CreativeWork was most recently modified or when the - * item's entry was modified within a DataFeed. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/dateModified + * @see http://schema.org/alternateName */ - public function dateModified($dateModified) + public function alternateName($alternateName) { - return $this->setProperty('dateModified', $dateModified); + return $this->setProperty('alternateName', $alternateName); } /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. * - * @param Thing|Thing[] $item + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated * * @return static * - * @see http://schema.org/item + * @see http://schema.org/dateCreated */ - public function item($item) + public function dateCreated($dateCreated) { - return $this->setProperty('item', $item); + return $this->setProperty('dateCreated', $dateCreated); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The datetime the item was removed from the DataFeed. * - * @param string|string[] $additionalType + * @param \DateTimeInterface|\DateTimeInterface[] $dateDeleted * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/dateDeleted */ - public function additionalType($additionalType) + public function dateDeleted($dateDeleted) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('dateDeleted', $dateDeleted); } /** - * An alias for the item. + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. * - * @param string|string[] $alternateName + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/dateModified */ - public function alternateName($alternateName) + public function dateModified($dateModified) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('dateModified', $dateModified); } /** @@ -169,6 +154,21 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background diff --git a/src/Dataset.php b/src/Dataset.php index 42ac67821..88d8adbab 100644 --- a/src/Dataset.php +++ b/src/Dataset.php @@ -13,95 +13,6 @@ */ class Dataset extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A data catalog which contains this dataset. - * - * @param DataCatalog|DataCatalog[] $catalog - * - * @return static - * - * @see http://schema.org/catalog - */ - public function catalog($catalog) - { - return $this->setProperty('catalog', $catalog); - } - - /** - * The range of temporal applicability of a dataset, e.g. for a 2011 census - * dataset, the year 2011 (in ISO 8601 time interval format). - * - * @param \DateTimeInterface|\DateTimeInterface[] $datasetTimeInterval - * - * @return static - * - * @see http://schema.org/datasetTimeInterval - */ - public function datasetTimeInterval($datasetTimeInterval) - { - return $this->setProperty('datasetTimeInterval', $datasetTimeInterval); - } - - /** - * A downloadable form of this dataset, at a specific location, in a - * specific format. - * - * @param DataDownload|DataDownload[] $distribution - * - * @return static - * - * @see http://schema.org/distribution - */ - public function distribution($distribution) - { - return $this->setProperty('distribution', $distribution); - } - - /** - * A data catalog which contains this dataset (this property was previously - * 'catalog', preferred name is now 'includedInDataCatalog'). - * - * @param DataCatalog|DataCatalog[] $includedDataCatalog - * - * @return static - * - * @see http://schema.org/includedDataCatalog - */ - public function includedDataCatalog($includedDataCatalog) - { - return $this->setProperty('includedDataCatalog', $includedDataCatalog); - } - - /** - * A data catalog which contains this dataset. - * - * @param DataCatalog|DataCatalog[] $includedInDataCatalog - * - * @return static - * - * @see http://schema.org/includedInDataCatalog - */ - public function includedInDataCatalog($includedInDataCatalog) - { - return $this->setProperty('includedInDataCatalog', $includedInDataCatalog); - } - - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - /** * The subject matter of the content. * @@ -246,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -261,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -362,6 +306,20 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A data catalog which contains this dataset. + * + * @param DataCatalog|DataCatalog[] $catalog + * + * @return static + * + * @see http://schema.org/catalog + */ + public function catalog($catalog) + { + return $this->setProperty('catalog', $catalog); + } + /** * Fictional person connected with a creative work. * @@ -508,6 +466,21 @@ public function creator($creator) return $this->setProperty('creator', $creator); } + /** + * The range of temporal applicability of a dataset, e.g. for a 2011 census + * dataset, the year 2011 (in ISO 8601 time interval format). + * + * @param \DateTimeInterface|\DateTimeInterface[] $datasetTimeInterval + * + * @return static + * + * @see http://schema.org/datasetTimeInterval + */ + public function datasetTimeInterval($datasetTimeInterval) + { + return $this->setProperty('datasetTimeInterval', $datasetTimeInterval); + } + /** * The date on which the CreativeWork was created or the item was added to a * DataFeed. @@ -552,6 +525,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -566,6 +570,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * A downloadable form of this dataset, at a specific location, in a + * specific format. + * + * @param DataDownload|DataDownload[] $distribution + * + * @return static + * + * @see http://schema.org/distribution + */ + public function distribution($distribution) + { + return $this->setProperty('distribution', $distribution); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -778,72 +797,134 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Language|Language[]|string|string[] $inLanguage + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/identifier */ - public function inLanguage($inLanguage) + public function identifier($identifier) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('identifier', $identifier); } /** - * The number of interactions for the CreativeWork using the WebSite or - * SoftwareApplication. The most specific child type of InteractionCounter - * should be used. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/interactionStatistic + * @see http://schema.org/image */ - public function interactionStatistic($interactionStatistic) + public function image($image) { - return $this->setProperty('interactionStatistic', $interactionStatistic); + return $this->setProperty('image', $image); } /** - * The predominant mode of learning supported by the learning resource. - * Acceptable values are 'active', 'expositive', or 'mixed'. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param string|string[] $interactivityType + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/interactivityType + * @see http://schema.org/inLanguage */ - public function interactivityType($interactivityType) + public function inLanguage($inLanguage) { - return $this->setProperty('interactivityType', $interactivityType); + return $this->setProperty('inLanguage', $inLanguage); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A data catalog which contains this dataset (this property was previously + * 'catalog', preferred name is now 'includedInDataCatalog'). * - * @param bool|bool[] $isAccessibleForFree + * @param DataCatalog|DataCatalog[] $includedDataCatalog * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/includedDataCatalog */ - public function isAccessibleForFree($isAccessibleForFree) + public function includedDataCatalog($includedDataCatalog) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('includedDataCatalog', $includedDataCatalog); } /** - * A resource from which this work is derived or from which it is a - * modification or adaption. + * A data catalog which contains this dataset. * - * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn + * @param DataCatalog|DataCatalog[] $includedInDataCatalog + * + * @return static + * + * @see http://schema.org/includedInDataCatalog + */ + public function includedInDataCatalog($includedInDataCatalog) + { + return $this->setProperty('includedInDataCatalog', $includedInDataCatalog); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * + * @return static + * + * @see http://schema.org/interactionStatistic + */ + public function interactionStatistic($interactionStatistic) + { + return $this->setProperty('interactionStatistic', $interactionStatistic); + } + + /** + * The predominant mode of learning supported by the learning resource. + * Acceptable values are 'active', 'expositive', or 'mixed'. + * + * @param string|string[] $interactivityType + * + * @return static + * + * @see http://schema.org/interactivityType + */ + public function interactivityType($interactivityType) + { + return $this->setProperty('interactivityType', $interactivityType); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * A resource from which this work is derived or from which it is a + * modification or adaption. + * + * @param CreativeWork|CreativeWork[]|Product|Product[]|string|string[] $isBasedOn * * @return static * @@ -899,6 +980,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -974,6 +1071,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1004,6 +1117,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1034,6 +1161,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1175,6 +1317,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1257,6 +1415,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1378,6 +1550,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1421,190 +1607,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/DatedMoneySpecification.php b/src/DatedMoneySpecification.php index c7ee88bc3..0dce651d8 100644 --- a/src/DatedMoneySpecification.php +++ b/src/DatedMoneySpecification.php @@ -18,72 +18,72 @@ class DatedMoneySpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** - * The amount of money. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/amount + * @see http://schema.org/additionalType */ - public function amount($amount) + public function additionalType($additionalType) { - return $this->setProperty('amount', $amount); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency in which the monetary amount is expressed. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An alias for the item. * - * @param string|string[] $currency + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/currency + * @see http://schema.org/alternateName */ - public function currency($currency) + public function alternateName($alternateName) { - return $this->setProperty('currency', $currency); + return $this->setProperty('alternateName', $alternateName); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The amount of money. * - * @param string|string[] $additionalType + * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/amount */ - public function additionalType($additionalType) + public function amount($amount) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('amount', $amount); } /** - * An alias for the item. + * The currency in which the monetary amount is expressed. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $alternateName + * @param string|string[] $currency * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/currency */ - public function alternateName($alternateName) + public function currency($currency) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('currency', $currency); } /** diff --git a/src/DaySpa.php b/src/DaySpa.php index 96bef7551..3ee0d891b 100644 --- a/src/DaySpa.php +++ b/src/DaySpa.php @@ -17,126 +17,104 @@ class DaySpa extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/DeactivateAction.php b/src/DeactivateAction.php index f0b412196..fc45e5413 100644 --- a/src/DeactivateAction.php +++ b/src/DeactivateAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/DefenceEstablishment.php b/src/DefenceEstablishment.php index e3d31bce1..8c4623ccb 100644 --- a/src/DefenceEstablishment.php +++ b/src/DefenceEstablishment.php @@ -15,35 +15,6 @@ */ class DefenceEstablishment extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/DeleteAction.php b/src/DeleteAction.php index ac3195b7e..31917e33c 100644 --- a/src/DeleteAction.php +++ b/src/DeleteAction.php @@ -15,382 +15,382 @@ class DeleteAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract { /** - * A sub property of object. The collection target of the action. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $collection + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/collection + * @see http://schema.org/actionStatus */ - public function collection($collection) + public function actionStatus($actionStatus) { - return $this->setProperty('collection', $collection); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of object. The collection target of the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $targetCollection + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/targetCollection + * @see http://schema.org/additionalType */ - public function targetCollection($targetCollection) + public function additionalType($additionalType) { - return $this->setProperty('targetCollection', $targetCollection); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of object. The collection target of the action. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Thing|Thing[] $collection * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/collection */ - public function endTime($endTime) + public function collection($collection) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('collection', $collection); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of object. The collection target of the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Thing|Thing[] $targetCollection * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/targetCollection */ - public function subjectOf($subjectOf) + public function targetCollection($targetCollection) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('targetCollection', $targetCollection); } /** diff --git a/src/DeliveryChargeSpecification.php b/src/DeliveryChargeSpecification.php index 603fc6698..ee5f4367a 100644 --- a/src/DeliveryChargeSpecification.php +++ b/src/DeliveryChargeSpecification.php @@ -15,6 +15,39 @@ */ class DeliveryChargeSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The delivery method(s) to which the delivery charge or payment charge * specification applies. @@ -45,40 +78,34 @@ public function areaServed($areaServed) } /** - * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the - * GeoShape for the geo-political region(s) for which the offer or delivery - * charge specification is valid. - * - * See also [[ineligibleRegion]]. + * A description of the item. * - * @param GeoShape|GeoShape[]|Place|Place[]|string|string[] $eligibleRegion + * @param string|string[] $description * * @return static * - * @see http://schema.org/eligibleRegion + * @see http://schema.org/description */ - public function eligibleRegion($eligibleRegion) + public function description($description) { - return $this->setProperty('eligibleRegion', $eligibleRegion); + return $this->setProperty('description', $description); } /** - * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the - * GeoShape for the geo-political region(s) for which the offer or delivery - * charge specification is not valid, e.g. a region where the transaction is - * not allowed. - * - * See also [[eligibleRegion]]. + * 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. * - * @param GeoShape|GeoShape[]|Place|Place[]|string|string[] $ineligibleRegion + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/ineligibleRegion + * @see http://schema.org/disambiguatingDescription */ - public function ineligibleRegion($ineligibleRegion) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('ineligibleRegion', $ineligibleRegion); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -98,338 +125,311 @@ public function eligibleQuantity($eligibleQuantity) } /** - * The transaction volume, in a monetary unit, for which the offer or price - * specification is valid, e.g. for indicating a minimal purchasing volume, - * to express free shipping above a certain order volume, or to limit the - * acceptance of credit cards to purchases to a certain minimal amount. + * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the + * GeoShape for the geo-political region(s) for which the offer or delivery + * charge specification is valid. + * + * See also [[ineligibleRegion]]. * - * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * @param GeoShape|GeoShape[]|Place|Place[]|string|string[] $eligibleRegion * * @return static * - * @see http://schema.org/eligibleTransactionVolume + * @see http://schema.org/eligibleRegion */ - public function eligibleTransactionVolume($eligibleTransactionVolume) + public function eligibleRegion($eligibleRegion) { - return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + return $this->setProperty('eligibleRegion', $eligibleRegion); } /** - * The highest price if the price is a range. + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. * - * @param float|float[]|int|int[] $maxPrice + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume * * @return static * - * @see http://schema.org/maxPrice + * @see http://schema.org/eligibleTransactionVolume */ - public function maxPrice($maxPrice) + public function eligibleTransactionVolume($eligibleTransactionVolume) { - return $this->setProperty('maxPrice', $maxPrice); + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); } /** - * The lowest price if the price is a range. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param float|float[]|int|int[] $minPrice + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/minPrice + * @see http://schema.org/identifier */ - public function minPrice($minPrice) + public function identifier($identifier) { - return $this->setProperty('minPrice', $minPrice); + return $this->setProperty('identifier', $identifier); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param float|float[]|int|int[]|string|string[] $price + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/price + * @see http://schema.org/image */ - public function price($price) + public function image($image) { - return $this->setProperty('price', $price); + return $this->setProperty('image', $image); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. + * The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the + * GeoShape for the geo-political region(s) for which the offer or delivery + * charge specification is not valid, e.g. a region where the transaction is + * not allowed. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $priceCurrency - * - * @return static - * - * @see http://schema.org/priceCurrency - */ - public function priceCurrency($priceCurrency) - { - return $this->setProperty('priceCurrency', $priceCurrency); - } - - /** - * The date when the item becomes valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom - * - * @return static - * - * @see http://schema.org/validFrom - */ - public function validFrom($validFrom) - { - return $this->setProperty('validFrom', $validFrom); - } - - /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. + * See also [[eligibleRegion]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * @param GeoShape|GeoShape[]|Place|Place[]|string|string[] $ineligibleRegion * * @return static * - * @see http://schema.org/validThrough + * @see http://schema.org/ineligibleRegion */ - public function validThrough($validThrough) + public function ineligibleRegion($ineligibleRegion) { - return $this->setProperty('validThrough', $validThrough); + return $this->setProperty('ineligibleRegion', $ineligibleRegion); } /** - * Specifies whether the applicable value-added tax (VAT) is included in the - * price specification or not. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param bool|bool[] $valueAddedTaxIncluded + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/valueAddedTaxIncluded + * @see http://schema.org/mainEntityOfPage */ - public function valueAddedTaxIncluded($valueAddedTaxIncluded) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The highest price if the price is a range. * - * @param string|string[] $additionalType + * @param float|float[]|int|int[] $maxPrice * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/maxPrice */ - public function additionalType($additionalType) + public function maxPrice($maxPrice) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('maxPrice', $maxPrice); } /** - * An alias for the item. + * The lowest price if the price is a range. * - * @param string|string[] $alternateName + * @param float|float[]|int|int[] $minPrice * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/minPrice */ - public function alternateName($alternateName) + public function minPrice($minPrice) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('minPrice', $minPrice); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/price */ - public function identifier($identifier) + public function price($price) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('price', $price); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceCurrency */ - public function image($image) + public function priceCurrency($priceCurrency) { - return $this->setProperty('image', $image); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The date when the item becomes valid. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validFrom */ - public function sameAs($sameAs) + public function validFrom($validFrom) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validFrom', $validFrom); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. * - * @param string|string[] $url + * @param bool|bool[] $valueAddedTaxIncluded * * @return static * - * @see http://schema.org/url + * @see http://schema.org/valueAddedTaxIncluded */ - public function url($url) + public function valueAddedTaxIncluded($valueAddedTaxIncluded) { - return $this->setProperty('url', $url); + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); } } diff --git a/src/DeliveryEvent.php b/src/DeliveryEvent.php index ddc8ae33d..2b394aa10 100644 --- a/src/DeliveryEvent.php +++ b/src/DeliveryEvent.php @@ -14,104 +14,95 @@ class DeliveryEvent extends BaseType implements EventContract, ThingContract { /** - * Password, PIN, or access code needed for delivery (e.g. from a locker). - * - * @param string|string[] $accessCode - * - * @return static - * - * @see http://schema.org/accessCode - */ - public function accessCode($accessCode) - { - return $this->setProperty('accessCode', $accessCode); - } - - /** - * When the item is available for pickup from the store, locker, etc. + * The subject matter of the content. * - * @param \DateTimeInterface|\DateTimeInterface[] $availableFrom + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/availableFrom + * @see http://schema.org/about */ - public function availableFrom($availableFrom) + public function about($about) { - return $this->setProperty('availableFrom', $availableFrom); + return $this->setProperty('about', $about); } /** - * After this date, the item will no longer be available for pickup. + * Password, PIN, or access code needed for delivery (e.g. from a locker). * - * @param \DateTimeInterface|\DateTimeInterface[] $availableThrough + * @param string|string[] $accessCode * * @return static * - * @see http://schema.org/availableThrough + * @see http://schema.org/accessCode */ - public function availableThrough($availableThrough) + public function accessCode($accessCode) { - return $this->setProperty('availableThrough', $availableThrough); + return $this->setProperty('accessCode', $accessCode); } /** - * Method used for delivery or shipping. + * 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. * - * @param DeliveryMethod|DeliveryMethod[] $hasDeliveryMethod + * @param Person|Person[] $actor * * @return static * - * @see http://schema.org/hasDeliveryMethod + * @see http://schema.org/actor */ - public function hasDeliveryMethod($hasDeliveryMethod) + public function actor($actor) { - return $this->setProperty('hasDeliveryMethod', $hasDeliveryMethod); + return $this->setProperty('actor', $actor); } /** - * The subject matter of the content. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $about + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/about + * @see http://schema.org/additionalType */ - public function about($about) + public function additionalType($additionalType) { - return $this->setProperty('about', $about); + return $this->setProperty('additionalType', $additionalType); } /** - * 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. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Person|Person[] $actor + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/actor + * @see http://schema.org/aggregateRating */ - public function actor($actor) + public function aggregateRating($aggregateRating) { - return $this->setProperty('actor', $actor); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An alias for the item. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/alternateName */ - public function aggregateRating($aggregateRating) + public function alternateName($alternateName) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('alternateName', $alternateName); } /** @@ -156,6 +147,34 @@ public function audience($audience) return $this->setProperty('audience', $audience); } + /** + * When the item is available for pickup from the store, locker, etc. + * + * @param \DateTimeInterface|\DateTimeInterface[] $availableFrom + * + * @return static + * + * @see http://schema.org/availableFrom + */ + public function availableFrom($availableFrom) + { + return $this->setProperty('availableFrom', $availableFrom); + } + + /** + * After this date, the item will no longer be available for pickup. + * + * @param \DateTimeInterface|\DateTimeInterface[] $availableThrough + * + * @return static + * + * @see http://schema.org/availableThrough + */ + public function availableThrough($availableThrough) + { + return $this->setProperty('availableThrough', $availableThrough); + } + /** * The person or organization who wrote a composition, or who is the * composer of a work performed at some event. @@ -185,6 +204,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -201,6 +234,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -275,6 +325,53 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * Method used for delivery or shipping. + * + * @param DeliveryMethod|DeliveryMethod[] $hasDeliveryMethod + * + * @return static + * + * @see http://schema.org/hasDeliveryMethod + */ + public function hasDeliveryMethod($hasDeliveryMethod) + { + return $this->setProperty('hasDeliveryMethod', $hasDeliveryMethod); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -321,6 +418,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -335,6 +448,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -395,6 +522,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -455,6 +597,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -517,6 +675,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -563,6 +735,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -594,190 +780,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Demand.php b/src/Demand.php index 3aa174ae0..1ae772dca 100644 --- a/src/Demand.php +++ b/src/Demand.php @@ -30,6 +30,25 @@ public function acceptedPaymentMethod($acceptedPaymentMethod) return $this->setProperty('acceptedPaymentMethod', $acceptedPaymentMethod); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The amount of time that is required between accepting the offer and the * actual usage of the resource or service. @@ -45,6 +64,20 @@ public function advanceBookingRequirement($advanceBookingRequirement) return $this->setProperty('advanceBookingRequirement', $advanceBookingRequirement); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -164,6 +197,37 @@ public function deliveryLeadTime($deliveryLeadTime) return $this->setProperty('deliveryLeadTime', $deliveryLeadTime); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The type(s) of customers for which the given offer is valid. * @@ -316,6 +380,39 @@ public function gtin8($gtin8) return $this->setProperty('gtin8', $gtin8); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * This links to a node or nodes indicating the exact quantity of the * products included in the offer. @@ -395,308 +492,211 @@ public function itemOffered($itemOffered) } /** - * The Manufacturer Part Number (MPN) of the product, or the product to - * which the offer refers. - * - * @param string|string[] $mpn - * - * @return static - * - * @see http://schema.org/mpn - */ - public function mpn($mpn) - { - return $this->setProperty('mpn', $mpn); - } - - /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. - * - * @param PriceSpecification|PriceSpecification[] $priceSpecification - * - * @return static - * - * @see http://schema.org/priceSpecification - */ - public function priceSpecification($priceSpecification) - { - return $this->setProperty('priceSpecification', $priceSpecification); - } - - /** - * An entity which offers (sells / leases / lends / loans) the services / - * goods. A seller may also be a provider. - * - * @param Organization|Organization[]|Person|Person[] $seller - * - * @return static - * - * @see http://schema.org/seller - */ - public function seller($seller) - { - return $this->setProperty('seller', $seller); - } - - /** - * The serial number or any alphanumeric identifier of a particular product. - * When attached to an offer, it is a shortcut for the serial number of the - * product included in the offer. - * - * @param string|string[] $serialNumber - * - * @return static - * - * @see http://schema.org/serialNumber - */ - public function serialNumber($serialNumber) - { - return $this->setProperty('serialNumber', $serialNumber); - } - - /** - * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a - * product or service, or the product to which the offer refers. - * - * @param string|string[] $sku - * - * @return static - * - * @see http://schema.org/sku - */ - public function sku($sku) - { - return $this->setProperty('sku', $sku); - } - - /** - * The date when the item becomes valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom - * - * @return static - * - * @see http://schema.org/validFrom - */ - public function validFrom($validFrom) - { - return $this->setProperty('validFrom', $validFrom); - } - - /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/validThrough + * @see http://schema.org/mainEntityOfPage */ - public function validThrough($validThrough) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('validThrough', $validThrough); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The warranty promise(s) included in the offer. + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. * - * @param WarrantyPromise|WarrantyPromise[] $warranty + * @param string|string[] $mpn * * @return static * - * @see http://schema.org/warranty + * @see http://schema.org/mpn */ - public function warranty($warranty) + public function mpn($mpn) { - return $this->setProperty('warranty', $warranty); + return $this->setProperty('mpn', $mpn); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param string|string[] $description + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/description + * @see http://schema.org/priceSpecification */ - public function description($description) + public function priceSpecification($priceSpecification) { - return $this->setProperty('description', $description); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * 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. + * 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. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/sameAs */ - public function disambiguatingDescription($disambiguatingDescription) + public function sameAs($sameAs) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('sameAs', $sameAs); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * An entity which offers (sells / leases / lends / loans) the services / + * goods. A seller may also be a provider. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $seller * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/seller */ - public function identifier($identifier) + public function seller($seller) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('seller', $seller); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The serial number or any alphanumeric identifier of a particular product. + * When attached to an offer, it is a shortcut for the serial number of the + * product included in the offer. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $serialNumber * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serialNumber */ - public function image($image) + public function serialNumber($serialNumber) { - return $this->setProperty('image', $image); + return $this->setProperty('serialNumber', $serialNumber); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a + * product or service, or the product to which the offer refers. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sku * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sku */ - public function mainEntityOfPage($mainEntityOfPage) + public function sku($sku) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sku', $sku); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The date when the item becomes valid. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validFrom */ - public function sameAs($sameAs) + public function validFrom($validFrom) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validFrom', $validFrom); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * The warranty promise(s) included in the offer. * - * @param string|string[] $url + * @param WarrantyPromise|WarrantyPromise[] $warranty * * @return static * - * @see http://schema.org/url + * @see http://schema.org/warranty */ - public function url($url) + public function warranty($warranty) { - return $this->setProperty('url', $url); + return $this->setProperty('warranty', $warranty); } } diff --git a/src/Dentist.php b/src/Dentist.php index 29dc8c94f..5ea26bffe 100644 --- a/src/Dentist.php +++ b/src/Dentist.php @@ -16,6 +16,47 @@ */ class Dentist extends BaseType implements MedicalOrganizationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { + /** + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. + * + * @param PropertyValue|PropertyValue[] $additionalProperty + * + * @return static + * + * @see http://schema.org/additionalProperty + */ + public function additionalProperty($additionalProperty) + { + return $this->setProperty('additionalProperty', $additionalProperty); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -45,6 +86,37 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. + * + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * + * @return static + * + * @see http://schema.org/amenityFeature + */ + public function amenityFeature($amenityFeature) + { + return $this->setProperty('amenityFeature', $amenityFeature); + } + /** * The geographic area where a service or offered item is provided. * @@ -87,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -130,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -147,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -332,6 +535,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -349,6 +566,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -379,31 +610,93 @@ public function hasPOS($hasPOS) } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $isicV4 + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/identifier */ - public function isicV4($isicV4) + public function identifier($identifier) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('identifier', $identifier); } /** - * The official name of the organization, e.g. the registered company name. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $legalName + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/image */ - public function legalName($legalName) + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + + /** + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. + * + * @param string|string[] $isicV4 + * + * @return static + * + * @see http://schema.org/isicV4 + */ + public function isicV4($isicV4) + { + return $this->setProperty('isicV4', $isicV4); + } + + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The official name of the organization, e.g. the registered company name. + * + * @param string|string[] $legalName + * + * @return static + * + * @see http://schema.org/legalName + */ + public function legalName($legalName) { return $this->setProperty('legalName', $legalName); } @@ -452,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -466,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -525,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -553,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -583,345 +1006,307 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/photos */ - public function reviews($reviews) + public function photos($photos) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Demand|Demand[] $seeks + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/potentialAction */ - public function seeks($seeks) + public function potentialAction($potentialAction) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The geographic area where the service is provided. + * The price range of the business, for example ```$$$```. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/priceRange */ - public function serviceArea($serviceArea) + public function priceRange($priceRange) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('priceRange', $priceRange); } /** - * A slogan or motto associated with the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $slogan + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization + * @see http://schema.org/publicAccess */ - public function subOrganization($subOrganization) + public function publicAccess($publicAccess) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $taxID + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/publishingPrinciples */ - public function taxID($taxID) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The telephone number. + * A review of the item. * - * @param string|string[] $telephone + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/review */ - public function telephone($telephone) + public function review($review) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('review', $review); } /** - * The Value-added Tax ID of the organization or person. + * Review of the item. * - * @param string|string[] $vatID + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/reviews */ - public function vatID($vatID) + public function reviews($reviews) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('reviews', $reviews); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * 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. * - * @param string|string[] $additionalType + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/sameAs */ - public function additionalType($additionalType) + public function sameAs($sameAs) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('sameAs', $sameAs); } /** - * An alias for the item. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param string|string[] $alternateName + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/seeks */ - public function alternateName($alternateName) + public function seeks($seeks) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('seeks', $seeks); } /** - * A description of the item. + * The geographic area where the service is provided. * - * @param string|string[] $description + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/description + * @see http://schema.org/serviceArea */ - public function description($description) + public function serviceArea($serviceArea) { - return $this->setProperty('description', $description); + return $this->setProperty('serviceArea', $serviceArea); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/slogan */ - public function disambiguatingDescription($disambiguatingDescription) + public function slogan($slogan) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('slogan', $slogan); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/smokingAllowed */ - public function identifier($identifier) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/specialOpeningHoursSpecification */ - public function image($image) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sponsor */ - public function mainEntityOfPage($mainEntityOfPage) + public function sponsor($sponsor) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sponsor', $sponsor); } /** - * The name of the item. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param string|string[] $name + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subOrganization */ - public function name($name) + public function subOrganization($subOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('subOrganization', $subOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param string|string[] $sameAs + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/taxID */ - public function sameAs($sameAs) + public function taxID($taxID) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('taxID', $taxID); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** @@ -939,402 +1324,17 @@ public function url($url) } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $currenciesAccepted + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/vatID */ - public function currenciesAccepted($currenciesAccepted) + public function vatID($vatID) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); - } - - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - - /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. - * - * @param string|string[] $paymentAccepted - * - * @return static - * - * @see http://schema.org/paymentAccepted - */ - public function paymentAccepted($paymentAccepted) - { - return $this->setProperty('paymentAccepted', $paymentAccepted); - } - - /** - * The price range of the business, for example ```$$$```. - * - * @param string|string[] $priceRange - * - * @return static - * - * @see http://schema.org/priceRange - */ - public function priceRange($priceRange) - { - return $this->setProperty('priceRange', $priceRange); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty - * - * @return static - * - * @see http://schema.org/additionalProperty - */ - public function additionalProperty($additionalProperty) - { - return $this->setProperty('additionalProperty', $additionalProperty); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. - * - * @param string|string[] $branchCode - * - * @return static - * - * @see http://schema.org/branchCode - */ - public function branchCode($branchCode) - { - return $this->setProperty('branchCode', $branchCode); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedIn - * - * @return static - * - * @see http://schema.org/containedIn - */ - public function containedIn($containedIn) - { - return $this->setProperty('containedIn', $containedIn); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedInPlace - * - * @return static - * - * @see http://schema.org/containedInPlace - */ - public function containedInPlace($containedInPlace) - { - return $this->setProperty('containedInPlace', $containedInPlace); - } - - /** - * The basic containment relation between a place and another that it - * contains. - * - * @param Place|Place[] $containsPlace - * - * @return static - * - * @see http://schema.org/containsPlace - */ - public function containsPlace($containsPlace) - { - return $this->setProperty('containsPlace', $containsPlace); - } - - /** - * The geo coordinates of the place. - * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo - * - * @return static - * - * @see http://schema.org/geo - */ - public function geo($geo) - { - return $this->setProperty('geo', $geo); - } - - /** - * A URL to a map of the place. - * - * @param Map|Map[]|string|string[] $hasMap - * - * @return static - * - * @see http://schema.org/hasMap - */ - public function hasMap($hasMap) - { - return $this->setProperty('hasMap', $hasMap); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $latitude - * - * @return static - * - * @see http://schema.org/latitude - */ - public function latitude($latitude) - { - return $this->setProperty('latitude', $latitude); - } - - /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $longitude - * - * @return static - * - * @see http://schema.org/longitude - */ - public function longitude($longitude) - { - return $this->setProperty('longitude', $longitude); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $map - * - * @return static - * - * @see http://schema.org/map - */ - public function map($map) - { - return $this->setProperty('map', $map); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $maps - * - * @return static - * - * @see http://schema.org/maps - */ - public function maps($maps) - { - return $this->setProperty('maps', $maps); - } - - /** - * The total number of individuals that may attend an event or venue. - * - * @param int|int[] $maximumAttendeeCapacity - * - * @return static - * - * @see http://schema.org/maximumAttendeeCapacity - */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) - { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); - } - - /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. - * - * @param bool|bool[] $smokingAllowed - * - * @return static - * - * @see http://schema.org/smokingAllowed - */ - public function smokingAllowed($smokingAllowed) - { - return $this->setProperty('smokingAllowed', $smokingAllowed); - } - - /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification - * - * @return static - * - * @see http://schema.org/specialOpeningHoursSpecification - */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) - { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/DepartAction.php b/src/DepartAction.php index e5be5aa9c..917f0f550 100644 --- a/src/DepartAction.php +++ b/src/DepartAction.php @@ -16,62 +16,96 @@ class DepartAction extends BaseType implements MoveActionContract, ActionContract, ThingContract { /** - * A sub property of location. The original location of the object or the - * agent before the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $fromLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/actionStatus */ - public function fromLocation($fromLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $toLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/additionalType */ - public function toLocation($toLocation) + public function additionalType($additionalType) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -112,288 +146,254 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Thing|Thing[] $object + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/object + * @see http://schema.org/fromLocation */ - public function object($object) + public function fromLocation($fromLocation) { - return $this->setProperty('object', $object); + return $this->setProperty('fromLocation', $fromLocation); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/DepartmentStore.php b/src/DepartmentStore.php index 2f1a7996b..9941ec29e 100644 --- a/src/DepartmentStore.php +++ b/src/DepartmentStore.php @@ -17,126 +17,104 @@ class DepartmentStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/DepositAccount.php b/src/DepositAccount.php index b566a933c..2672dac5b 100644 --- a/src/DepositAccount.php +++ b/src/DepositAccount.php @@ -19,65 +19,82 @@ class DepositAccount extends BaseType implements BankAccountContract, InvestmentOrDepositContract, FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/additionalType */ - public function annualPercentageRate($annualPercentageRate) + public function additionalType($additionalType) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('additionalType', $additionalType); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/aggregateRating */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function aggregateRating($aggregateRating) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/alternateName */ - public function interestRate($interestRate) + public function alternateName($alternateName) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The amount of money. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amount */ - public function aggregateRating($aggregateRating) + public function amount($amount) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amount', $amount); + } + + /** + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * + * @return static + * + * @see http://schema.org/annualPercentageRate + */ + public function annualPercentageRate($annualPercentageRate) + { + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -185,380 +202,377 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * A description of the item. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/description */ - public function hasOfferCatalog($hasOfferCatalog) + public function description($description) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('description', $description); } /** - * The hours during which this service or contact is available. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/disambiguatingDescription */ - public function hoursAvailable($hoursAvailable) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, somehow related product (or multiple products). + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param string|string[] $feesAndCommissionsSpecification * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/feesAndCommissionsSpecification */ - public function isRelatedTo($isRelatedTo) + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/hasOfferCatalog */ - public function isSimilarTo($isSimilarTo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An associated logo. + * The hours during which this service or contact is available. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hoursAvailable */ - public function logo($logo) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $offers + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/identifier */ - public function offers($offers) + public function identifier($identifier) { - return $this->setProperty('offers', $offers); + return $this->setProperty('identifier', $identifier); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $produces + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/image */ - public function produces($produces) + public function image($image) { - return $this->setProperty('produces', $produces); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/interestRate */ - public function provider($provider) + public function interestRate($interestRate) { - return $this->setProperty('provider', $provider); + return $this->setProperty('interestRate', $interestRate); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * A pointer to another, somehow related product (or multiple products). * - * @param string|string[] $providerMobility + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/isRelatedTo */ - public function providerMobility($providerMobility) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * A review of the item. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param Review|Review[] $review + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/isSimilarTo */ - public function review($review) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('review', $review); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * The geographic area where the service is provided. + * An associated logo. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/logo */ - public function serviceArea($serviceArea) + public function logo($logo) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('logo', $logo); } /** - * The audience eligible for this service. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Audience|Audience[] $serviceAudience + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/mainEntityOfPage */ - public function serviceAudience($serviceAudience) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * The name of the item. * - * @param Thing|Thing[] $serviceOutput + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/name */ - public function serviceOutput($serviceOutput) + public function name($name) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('name', $name); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param string|string[] $serviceType + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/offers */ - public function serviceType($serviceType) + public function offers($offers) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('offers', $offers); } /** - * A slogan or motto associated with the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $slogan + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/potentialAction */ - public function slogan($slogan) + public function potentialAction($potentialAction) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/produces */ - public function additionalType($additionalType) + public function produces($produces) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('produces', $produces); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $description + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/description + * @see http://schema.org/providerMobility */ - public function description($description) + public function providerMobility($providerMobility) { - return $this->setProperty('description', $description); + return $this->setProperty('providerMobility', $providerMobility); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** @@ -589,18 +603,4 @@ public function url($url) return $this->setProperty('url', $url); } - /** - * The amount of money. - * - * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount - * - * @return static - * - * @see http://schema.org/amount - */ - public function amount($amount) - { - return $this->setProperty('amount', $amount); - } - } diff --git a/src/DigitalDocument.php b/src/DigitalDocument.php index aa7bc0152..d2521372f 100644 --- a/src/DigitalDocument.php +++ b/src/DigitalDocument.php @@ -13,22 +13,6 @@ */ class DigitalDocument extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A permission related to the access to this document (e.g. permission to - * read or write an electronic document). For a public document, specify a - * grantee with an Audience with audienceType equal to "public". - * - * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission - * - * @return static - * - * @see http://schema.org/hasDigitalDocumentPermission - */ - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) - { - return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); - } - /** * The subject matter of the content. * @@ -173,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -188,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -479,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -675,6 +723,22 @@ public function genre($genre) return $this->setProperty('genre', $genre); } + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + /** * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). @@ -704,6 +768,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -901,6 +998,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -931,6 +1044,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -961,6 +1088,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1102,6 +1244,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1184,6 +1342,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1305,6 +1477,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1348,190 +1534,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/DigitalDocumentPermission.php b/src/DigitalDocumentPermission.php index 55cdb4115..ee086b0db 100644 --- a/src/DigitalDocumentPermission.php +++ b/src/DigitalDocumentPermission.php @@ -13,35 +13,6 @@ */ class DigitalDocumentPermission extends BaseType implements IntangibleContract, ThingContract { - /** - * The person, organization, contact point, or audience that has been - * granted this permission. - * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $grantee - * - * @return static - * - * @see http://schema.org/grantee - */ - public function grantee($grantee) - { - return $this->setProperty('grantee', $grantee); - } - - /** - * The type of permission granted the person, organization, or audience. - * - * @param DigitalDocumentPermissionType|DigitalDocumentPermissionType[] $permissionType - * - * @return static - * - * @see http://schema.org/permissionType - */ - public function permissionType($permissionType) - { - return $this->setProperty('permissionType', $permissionType); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -106,6 +77,21 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The person, organization, contact point, or audience that has been + * granted this permission. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $grantee + * + * @return static + * + * @see http://schema.org/grantee + */ + public function grantee($grantee) + { + return $this->setProperty('grantee', $grantee); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -169,6 +155,20 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The type of permission granted the person, organization, or audience. + * + * @param DigitalDocumentPermissionType|DigitalDocumentPermissionType[] $permissionType + * + * @return static + * + * @see http://schema.org/permissionType + */ + public function permissionType($permissionType) + { + return $this->setProperty('permissionType', $permissionType); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/DisagreeAction.php b/src/DisagreeAction.php index 3e790b830..ffb0ca073 100644 --- a/src/DisagreeAction.php +++ b/src/DisagreeAction.php @@ -32,340 +32,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/DiscoverAction.php b/src/DiscoverAction.php index 8fb6b7a0e..d189e66cd 100644 --- a/src/DiscoverAction.php +++ b/src/DiscoverAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/DiscussionForumPosting.php b/src/DiscussionForumPosting.php index be7a60882..40d057af9 100644 --- a/src/DiscussionForumPosting.php +++ b/src/DiscussionForumPosting.php @@ -15,146 +15,6 @@ */ class DiscussionForumPosting extends BaseType implements SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract { - /** - * A CreativeWork such as an image, video, or audio clip shared as part of - * this posting. - * - * @param CreativeWork|CreativeWork[] $sharedContent - * - * @return static - * - * @see http://schema.org/sharedContent - */ - public function sharedContent($sharedContent) - { - return $this->setProperty('sharedContent', $sharedContent); - } - - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -299,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -314,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -328,6 +221,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -605,6 +527,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -831,28 +784,61 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Language|Language[]|string|string[] $inLanguage + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/identifier */ - public function inLanguage($inLanguage) + public function identifier($identifier) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('identifier', $identifier); } /** - * The number of interactions for the CreativeWork using the WebSite or - * SoftwareApplication. The most specific child type of InteractionCounter - * should be used. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic * * @return static * @@ -1027,6 +1013,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1057,6 +1059,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1073,6 +1089,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1087,6 +1146,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1228,6 +1302,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1245,6 +1335,21 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A CreativeWork such as an image, video, or audio clip shared as part of + * this posting. + * + * @param CreativeWork|CreativeWork[] $sharedContent + * + * @return static + * + * @see http://schema.org/sharedContent + */ + public function sharedContent($sharedContent) + { + return $this->setProperty('sharedContent', $sharedContent); + } + /** * The Organization on whose behalf the creator was working. * @@ -1294,6 +1399,45 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + /** * 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 @@ -1310,6 +1454,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1431,6 +1589,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1460,204 +1632,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/DislikeAction.php b/src/DislikeAction.php index 2b7b61d03..c40bd3733 100644 --- a/src/DislikeAction.php +++ b/src/DislikeAction.php @@ -31,340 +31,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Distillery.php b/src/Distillery.php index ab5789073..4e605233c 100644 --- a/src/Distillery.php +++ b/src/Distillery.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/DonateAction.php b/src/DonateAction.php index e747d19f2..6ebdbe5d7 100644 --- a/src/DonateAction.php +++ b/src/DonateAction.php @@ -16,122 +16,96 @@ class DonateAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * Indicates the current disposition of the Action. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/actionStatus */ - public function recipient($recipient) + public function actionStatus($actionStatus) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param float|float[]|int|int[]|string|string[] $price + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/price + * @see http://schema.org/additionalType */ - public function price($price) + public function additionalType($additionalType) { - return $this->setProperty('price', $price); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param string|string[] $priceCurrency + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/agent */ - public function priceCurrency($priceCurrency) + public function agent($agent) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('agent', $agent); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * An alias for the item. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/alternateName */ - public function priceSpecification($priceSpecification) + public function alternateName($alternateName) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -172,288 +146,314 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $instrument + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/identifier */ - public function instrument($instrument) + public function identifier($identifier) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/object + * @see http://schema.org/instrument */ - public function object($object) + public function instrument($instrument) { - return $this->setProperty('object', $object); + return $this->setProperty('instrument', $instrument); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/location */ - public function participant($participant) + public function location($location) { - return $this->setProperty('participant', $participant); + return $this->setProperty('location', $location); } /** - * The result produced in the action. e.g. John wrote *a book*. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $result + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/result + * @see http://schema.org/mainEntityOfPage */ - public function result($result) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('result', $result); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The name of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param string|string[] $name * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/name */ - public function startTime($startTime) + public function name($name) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('name', $name); } /** - * Indicates a target EntryPoint for an Action. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/target + * @see http://schema.org/object */ - public function target($target) + public function object($object) { - return $this->setProperty('target', $target); + return $this->setProperty('object', $object); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/participant */ - public function additionalType($additionalType) + public function participant($participant) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('participant', $participant); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $description + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/description + * @see http://schema.org/price */ - public function description($description) + public function price($price) { - return $this->setProperty('description', $description); + return $this->setProperty('price', $price); } /** - * 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. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/priceCurrency */ - public function disambiguatingDescription($disambiguatingDescription) + public function priceCurrency($priceCurrency) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceSpecification */ - public function identifier($identifier) + public function priceSpecification($priceSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/DownloadAction.php b/src/DownloadAction.php index 2044cbf07..19e9bb23c 100644 --- a/src/DownloadAction.php +++ b/src/DownloadAction.php @@ -15,62 +15,96 @@ class DownloadAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** - * A sub property of location. The original location of the object or the - * agent before the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $fromLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/actionStatus */ - public function fromLocation($fromLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $toLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/additionalType */ - public function toLocation($toLocation) + public function additionalType($additionalType) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -111,288 +145,254 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Thing|Thing[] $object + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/object + * @see http://schema.org/fromLocation */ - public function object($object) + public function fromLocation($fromLocation) { - return $this->setProperty('object', $object); + return $this->setProperty('fromLocation', $fromLocation); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/DrawAction.php b/src/DrawAction.php index 6651805f8..6b352698e 100644 --- a/src/DrawAction.php +++ b/src/DrawAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/DrinkAction.php b/src/DrinkAction.php index f6907d6fe..1cbdea383 100644 --- a/src/DrinkAction.php +++ b/src/DrinkAction.php @@ -31,33 +31,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -76,325 +79,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/DriveWheelConfigurationValue.php b/src/DriveWheelConfigurationValue.php index 72d3540d5..4ff973940 100644 --- a/src/DriveWheelConfigurationValue.php +++ b/src/DriveWheelConfigurationValue.php @@ -70,205 +70,175 @@ public function additionalProperty($additionalProperty) } /** - * This ordering relation for qualitative values indicates that the subject - * is equal to the object. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QualitativeValue|QualitativeValue[] $equal + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/equal + * @see http://schema.org/additionalType */ - public function equal($equal) + public function additionalType($additionalType) { - return $this->setProperty('equal', $equal); + return $this->setProperty('additionalType', $additionalType); } /** - * This ordering relation for qualitative values indicates that the subject - * is greater than the object. + * An alias for the item. * - * @param QualitativeValue|QualitativeValue[] $greater + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/greater + * @see http://schema.org/alternateName */ - public function greater($greater) + public function alternateName($alternateName) { - return $this->setProperty('greater', $greater); + return $this->setProperty('alternateName', $alternateName); } /** - * This ordering relation for qualitative values indicates that the subject - * is greater than or equal to the object. + * A description of the item. * - * @param QualitativeValue|QualitativeValue[] $greaterOrEqual + * @param string|string[] $description * * @return static * - * @see http://schema.org/greaterOrEqual + * @see http://schema.org/description */ - public function greaterOrEqual($greaterOrEqual) + public function description($description) { - return $this->setProperty('greaterOrEqual', $greaterOrEqual); + return $this->setProperty('description', $description); } /** - * This ordering relation for qualitative values indicates that the subject - * is lesser than the object. + * 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. * - * @param QualitativeValue|QualitativeValue[] $lesser + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/lesser + * @see http://schema.org/disambiguatingDescription */ - public function lesser($lesser) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('lesser', $lesser); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** * This ordering relation for qualitative values indicates that the subject - * is lesser than or equal to the object. + * is equal to the object. * - * @param QualitativeValue|QualitativeValue[] $lesserOrEqual + * @param QualitativeValue|QualitativeValue[] $equal * * @return static * - * @see http://schema.org/lesserOrEqual + * @see http://schema.org/equal */ - public function lesserOrEqual($lesserOrEqual) + public function equal($equal) { - return $this->setProperty('lesserOrEqual', $lesserOrEqual); + return $this->setProperty('equal', $equal); } /** * This ordering relation for qualitative values indicates that the subject - * is not equal to the object. - * - * @param QualitativeValue|QualitativeValue[] $nonEqual - * - * @return static - * - * @see http://schema.org/nonEqual - */ - public function nonEqual($nonEqual) - { - return $this->setProperty('nonEqual', $nonEqual); - } - - /** - * A pointer to a secondary value that provides additional information on - * the original value, e.g. a reference temperature. - * - * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference - * - * @return static - * - * @see http://schema.org/valueReference - */ - public function valueReference($valueReference) - { - return $this->setProperty('valueReference', $valueReference); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * is greater than the object. * - * @param string|string[] $additionalType + * @param QualitativeValue|QualitativeValue[] $greater * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/greater */ - public function additionalType($additionalType) + public function greater($greater) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('greater', $greater); } /** - * An alias for the item. + * This ordering relation for qualitative values indicates that the subject + * is greater than or equal to the object. * - * @param string|string[] $alternateName + * @param QualitativeValue|QualitativeValue[] $greaterOrEqual * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/greaterOrEqual */ - public function alternateName($alternateName) + public function greaterOrEqual($greaterOrEqual) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('greaterOrEqual', $greaterOrEqual); } /** - * A description of the item. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $description + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/description + * @see http://schema.org/identifier */ - public function description($description) + public function identifier($identifier) { - return $this->setProperty('description', $description); + return $this->setProperty('identifier', $identifier); } /** - * 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. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $disambiguatingDescription + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/image */ - public function disambiguatingDescription($disambiguatingDescription) + public function image($image) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('image', $image); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * This ordering relation for qualitative values indicates that the subject + * is lesser than the object. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param QualitativeValue|QualitativeValue[] $lesser * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/lesser */ - public function identifier($identifier) + public function lesser($lesser) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('lesser', $lesser); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * This ordering relation for qualitative values indicates that the subject + * is lesser than or equal to the object. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param QualitativeValue|QualitativeValue[] $lesserOrEqual * * @return static * - * @see http://schema.org/image + * @see http://schema.org/lesserOrEqual */ - public function image($image) + public function lesserOrEqual($lesserOrEqual) { - return $this->setProperty('image', $image); + return $this->setProperty('lesserOrEqual', $lesserOrEqual); } /** @@ -301,6 +271,21 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * This ordering relation for qualitative values indicates that the subject + * is not equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $nonEqual + * + * @return static + * + * @see http://schema.org/nonEqual + */ + public function nonEqual($nonEqual) + { + return $this->setProperty('nonEqual', $nonEqual); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -360,4 +345,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + } diff --git a/src/DryCleaningOrLaundry.php b/src/DryCleaningOrLaundry.php index 7436d4107..fad8bdc53 100644 --- a/src/DryCleaningOrLaundry.php +++ b/src/DryCleaningOrLaundry.php @@ -16,126 +16,104 @@ class DryCleaningOrLaundry extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/EatAction.php b/src/EatAction.php index 4971c9d8e..a1abff170 100644 --- a/src/EatAction.php +++ b/src/EatAction.php @@ -31,33 +31,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -76,325 +79,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/EducationEvent.php b/src/EducationEvent.php index b883c89e1..b47b90bfd 100644 --- a/src/EducationEvent.php +++ b/src/EducationEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/EducationalAudience.php b/src/EducationalAudience.php index 627eab8d5..05715738d 100644 --- a/src/EducationalAudience.php +++ b/src/EducationalAudience.php @@ -14,49 +14,6 @@ */ class EducationalAudience extends BaseType implements AudienceContract, IntangibleContract, ThingContract { - /** - * An educationalRole of an EducationalAudience. - * - * @param string|string[] $educationalRole - * - * @return static - * - * @see http://schema.org/educationalRole - */ - public function educationalRole($educationalRole) - { - return $this->setProperty('educationalRole', $educationalRole); - } - - /** - * The target group associated with a given audience (e.g. veterans, car - * owners, musicians, etc.). - * - * @param string|string[] $audienceType - * - * @return static - * - * @see http://schema.org/audienceType - */ - public function audienceType($audienceType) - { - return $this->setProperty('audienceType', $audienceType); - } - - /** - * The geographic area associated with the audience. - * - * @param AdministrativeArea|AdministrativeArea[] $geographicArea - * - * @return static - * - * @see http://schema.org/geographicArea - */ - public function geographicArea($geographicArea) - { - return $this->setProperty('geographicArea', $geographicArea); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -90,6 +47,21 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The target group associated with a given audience (e.g. veterans, car + * owners, musicians, etc.). + * + * @param string|string[] $audienceType + * + * @return static + * + * @see http://schema.org/audienceType + */ + public function audienceType($audienceType) + { + return $this->setProperty('audienceType', $audienceType); + } + /** * A description of the item. * @@ -121,6 +93,34 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * An educationalRole of an EducationalAudience. + * + * @param string|string[] $educationalRole + * + * @return static + * + * @see http://schema.org/educationalRole + */ + public function educationalRole($educationalRole) + { + return $this->setProperty('educationalRole', $educationalRole); + } + + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides diff --git a/src/EducationalOrganization.php b/src/EducationalOrganization.php index 3d7fa2d72..7ff415d67 100644 --- a/src/EducationalOrganization.php +++ b/src/EducationalOrganization.php @@ -14,17 +14,22 @@ class EducationalOrganization extends BaseType implements OrganizationContract, ThingContract { /** - * Alumni of an organization. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $alumni + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/alumni + * @see http://schema.org/additionalType */ - public function alumni($alumni) + public function additionalType($additionalType) { - return $this->setProperty('alumni', $alumni); + return $this->setProperty('additionalType', $additionalType); } /** @@ -56,6 +61,34 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + /** * The geographic area where a service or offered item is provided. * @@ -158,6 +191,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -389,6 +453,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -463,6 +560,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -536,6 +649,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -593,6 +720,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -645,6 +787,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -720,6 +878,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -750,203 +922,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Electrician.php b/src/Electrician.php index ae315c1c2..bf7005e76 100644 --- a/src/Electrician.php +++ b/src/Electrician.php @@ -17,126 +17,104 @@ class Electrician extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ElectronicsStore.php b/src/ElectronicsStore.php index 2679f088c..5dfbb2271 100644 --- a/src/ElectronicsStore.php +++ b/src/ElectronicsStore.php @@ -17,126 +17,104 @@ class ElectronicsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ElementarySchool.php b/src/ElementarySchool.php index 733833b20..70298cb81 100644 --- a/src/ElementarySchool.php +++ b/src/ElementarySchool.php @@ -15,17 +15,22 @@ class ElementarySchool extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { /** - * Alumni of an organization. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $alumni + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/alumni + * @see http://schema.org/additionalType */ - public function alumni($alumni) + public function additionalType($additionalType) { - return $this->setProperty('alumni', $alumni); + return $this->setProperty('additionalType', $additionalType); } /** @@ -57,6 +62,34 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + /** * The geographic area where a service or offered item is provided. * @@ -159,6 +192,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -390,6 +454,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -464,6 +561,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -537,6 +650,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -594,6 +721,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -646,6 +788,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -721,6 +879,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -751,203 +923,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/EmailMessage.php b/src/EmailMessage.php index 5c88d4e1e..822de39c6 100644 --- a/src/EmailMessage.php +++ b/src/EmailMessage.php @@ -14,136 +14,6 @@ */ class EmailMessage extends BaseType implements MessageContract, CreativeWorkContract, ThingContract { - /** - * A sub property of recipient. The recipient blind copied on a message. - * - * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $bccRecipient - * - * @return static - * - * @see http://schema.org/bccRecipient - */ - public function bccRecipient($bccRecipient) - { - return $this->setProperty('bccRecipient', $bccRecipient); - } - - /** - * A sub property of recipient. The recipient copied on a message. - * - * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $ccRecipient - * - * @return static - * - * @see http://schema.org/ccRecipient - */ - public function ccRecipient($ccRecipient) - { - return $this->setProperty('ccRecipient', $ccRecipient); - } - - /** - * The date/time at which the message has been read by the recipient if a - * single recipient exists. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateRead - * - * @return static - * - * @see http://schema.org/dateRead - */ - public function dateRead($dateRead) - { - return $this->setProperty('dateRead', $dateRead); - } - - /** - * The date/time the message was received if a single recipient exists. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateReceived - * - * @return static - * - * @see http://schema.org/dateReceived - */ - public function dateReceived($dateReceived) - { - return $this->setProperty('dateReceived', $dateReceived); - } - - /** - * The date/time at which the message was sent. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateSent - * - * @return static - * - * @see http://schema.org/dateSent - */ - public function dateSent($dateSent) - { - return $this->setProperty('dateSent', $dateSent); - } - - /** - * A CreativeWork attached to the message. - * - * @param CreativeWork|CreativeWork[] $messageAttachment - * - * @return static - * - * @see http://schema.org/messageAttachment - */ - public function messageAttachment($messageAttachment) - { - return $this->setProperty('messageAttachment', $messageAttachment); - } - - /** - * A sub property of participant. The participant who is at the receiving - * end of the action. - * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient - * - * @return static - * - * @see http://schema.org/recipient - */ - public function recipient($recipient) - { - return $this->setProperty('recipient', $recipient); - } - - /** - * A sub property of participant. The participant who is at the sending end - * of the action. - * - * @param Audience|Audience[]|Organization|Organization[]|Person|Person[] $sender - * - * @return static - * - * @see http://schema.org/sender - */ - public function sender($sender) - { - return $this->setProperty('sender', $sender); - } - - /** - * A sub property of recipient. The recipient who was directly sent the - * message. - * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $toRecipient - * - * @return static - * - * @see http://schema.org/toRecipient - */ - public function toRecipient($toRecipient) - { - return $this->setProperty('toRecipient', $toRecipient); - } - /** * The subject matter of the content. * @@ -288,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -303,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -404,6 +307,34 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A sub property of recipient. The recipient blind copied on a message. + * + * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $bccRecipient + * + * @return static + * + * @see http://schema.org/bccRecipient + */ + public function bccRecipient($bccRecipient) + { + return $this->setProperty('bccRecipient', $bccRecipient); + } + + /** + * A sub property of recipient. The recipient copied on a message. + * + * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $ccRecipient + * + * @return static + * + * @see http://schema.org/ccRecipient + */ + public function ccRecipient($ccRecipient) + { + return $this->setProperty('ccRecipient', $ccRecipient); + } + /** * Fictional person connected with a creative work. * @@ -595,87 +526,161 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * The date/time at which the message has been read by the recipient if a + * single recipient exists. * - * @param string|string[] $discussionUrl + * @param \DateTimeInterface|\DateTimeInterface[] $dateRead * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/dateRead */ - public function discussionUrl($discussionUrl) + public function dateRead($dateRead) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('dateRead', $dateRead); } /** - * Specifies the Person who edited the CreativeWork. + * The date/time the message was received if a single recipient exists. * - * @param Person|Person[] $editor + * @param \DateTimeInterface|\DateTimeInterface[] $dateReceived * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/dateReceived */ - public function editor($editor) + public function dateReceived($dateReceived) { - return $this->setProperty('editor', $editor); + return $this->setProperty('dateReceived', $dateReceived); } /** - * An alignment to an established educational framework. + * The date/time at which the message was sent. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param \DateTimeInterface|\DateTimeInterface[] $dateSent * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/dateSent */ - public function educationalAlignment($educationalAlignment) + public function dateSent($dateSent) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('dateSent', $dateSent); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * A description of the item. * - * @param string|string[] $educationalUse + * @param string|string[] $description * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/description */ - public function educationalUse($educationalUse) + public function description($description) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('description', $description); } /** - * A media object that encodes this CreativeWork. This property is a synonym - * for associatedMedia. + * 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. * - * @param MediaObject|MediaObject[] $encoding + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/encoding + * @see http://schema.org/disambiguatingDescription */ - public function encoding($encoding) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('encoding', $encoding); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside * particular [[encodingFormat]] information. * * Unregistered or niche encoding and file formats can be indicated instead @@ -819,6 +824,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1016,6 +1054,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1046,6 +1100,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * A CreativeWork attached to the message. + * + * @param CreativeWork|CreativeWork[] $messageAttachment + * + * @return static + * + * @see http://schema.org/messageAttachment + */ + public function messageAttachment($messageAttachment) + { + return $this->setProperty('messageAttachment', $messageAttachment); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1076,6 +1158,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1159,6 +1256,21 @@ public function publishingPrinciples($publishingPrinciples) return $this->setProperty('publishingPrinciples', $publishingPrinciples); } + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + /** * The Event where the CreativeWork was recorded. The CreativeWork may * capture all or part of the event. @@ -1217,6 +1329,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1234,6 +1362,21 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A sub property of participant. The participant who is at the sending end + * of the action. + * + * @param Audience|Audience[]|Organization|Organization[]|Person|Person[] $sender + * + * @return static + * + * @see http://schema.org/sender + */ + public function sender($sender) + { + return $this->setProperty('sender', $sender); + } + /** * The Organization on whose behalf the creator was working. * @@ -1299,6 +1442,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1390,6 +1547,21 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * A sub property of recipient. The recipient who was directly sent the + * message. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $toRecipient + * + * @return static + * + * @see http://schema.org/toRecipient + */ + public function toRecipient($toRecipient) + { + return $this->setProperty('toRecipient', $toRecipient); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1420,6 +1592,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1463,190 +1649,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Embassy.php b/src/Embassy.php index 3e993ae7e..3f1da3fbf 100644 --- a/src/Embassy.php +++ b/src/Embassy.php @@ -15,35 +15,6 @@ */ class Embassy extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/EmergencyService.php b/src/EmergencyService.php index 720167290..9671de0ea 100644 --- a/src/EmergencyService.php +++ b/src/EmergencyService.php @@ -16,126 +16,104 @@ class EmergencyService extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/EmployeeRole.php b/src/EmployeeRole.php index fddf298df..3382cf8fb 100644 --- a/src/EmployeeRole.php +++ b/src/EmployeeRole.php @@ -15,114 +15,6 @@ */ class EmployeeRole extends BaseType implements OrganizationRoleContract, RoleContract, IntangibleContract, ThingContract { - /** - * The base salary of the job or of an employee in an EmployeeRole. - * - * @param MonetaryAmount|MonetaryAmount[]|PriceSpecification|PriceSpecification[]|float|float[]|int|int[] $baseSalary - * - * @return static - * - * @see http://schema.org/baseSalary - */ - public function baseSalary($baseSalary) - { - return $this->setProperty('baseSalary', $baseSalary); - } - - /** - * The currency (coded using [ISO - * 4217](http://en.wikipedia.org/wiki/ISO_4217) ) used for the main salary - * information in this job posting or for this employee. - * - * @param string|string[] $salaryCurrency - * - * @return static - * - * @see http://schema.org/salaryCurrency - */ - public function salaryCurrency($salaryCurrency) - { - return $this->setProperty('salaryCurrency', $salaryCurrency); - } - - /** - * A number associated with a role in an organization, for example, the - * number on an athlete's jersey. - * - * @param float|float[]|int|int[] $numberedPosition - * - * @return static - * - * @see http://schema.org/numberedPosition - */ - public function numberedPosition($numberedPosition) - { - return $this->setProperty('numberedPosition', $numberedPosition); - } - - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * A position played, performed or filled by a person or organization, as - * part of an organization. For example, an athlete in a SportsTeam might - * play in the position named 'Quarterback'. - * - * @param string|string[] $namedPosition - * - * @return static - * - * @see http://schema.org/namedPosition - */ - public function namedPosition($namedPosition) - { - return $this->setProperty('namedPosition', $namedPosition); - } - - /** - * A role played, performed or filled by a person or organization. For - * example, the team of creators for a comic book might fill the roles named - * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might - * play in the position named 'Quarterback'. - * - * @param string|string[] $roleName - * - * @return static - * - * @see http://schema.org/roleName - */ - public function roleName($roleName) - { - return $this->setProperty('roleName', $roleName); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -156,6 +48,20 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The base salary of the job or of an employee in an EmployeeRole. + * + * @param MonetaryAmount|MonetaryAmount[]|PriceSpecification|PriceSpecification[]|float|float[]|int|int[] $baseSalary + * + * @return static + * + * @see http://schema.org/baseSalary + */ + public function baseSalary($baseSalary) + { + return $this->setProperty('baseSalary', $baseSalary); + } + /** * A description of the item. * @@ -187,6 +93,21 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -250,6 +171,37 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A position played, performed or filled by a person or organization, as + * part of an organization. For example, an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $namedPosition + * + * @return static + * + * @see http://schema.org/namedPosition + */ + public function namedPosition($namedPosition) + { + return $this->setProperty('namedPosition', $namedPosition); + } + + /** + * A number associated with a role in an organization, for example, the + * number on an athlete's jersey. + * + * @param float|float[]|int|int[] $numberedPosition + * + * @return static + * + * @see http://schema.org/numberedPosition + */ + public function numberedPosition($numberedPosition) + { + return $this->setProperty('numberedPosition', $numberedPosition); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -265,6 +217,39 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A role played, performed or filled by a person or organization. For + * example, the team of creators for a comic book might fill the roles named + * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $roleName + * + * @return static + * + * @see http://schema.org/roleName + */ + public function roleName($roleName) + { + return $this->setProperty('roleName', $roleName); + } + + /** + * The currency (coded using [ISO + * 4217](http://en.wikipedia.org/wiki/ISO_4217) ) used for the main salary + * information in this job posting or for this employee. + * + * @param string|string[] $salaryCurrency + * + * @return static + * + * @see http://schema.org/salaryCurrency + */ + public function salaryCurrency($salaryCurrency) + { + return $this->setProperty('salaryCurrency', $salaryCurrency); + } + /** * 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 @@ -281,6 +266,21 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + /** * A CreativeWork or Event about this Thing. * diff --git a/src/EmployerAggregateRating.php b/src/EmployerAggregateRating.php index 1341ac029..cf9165780 100644 --- a/src/EmployerAggregateRating.php +++ b/src/EmployerAggregateRating.php @@ -16,45 +16,36 @@ class EmployerAggregateRating extends BaseType implements AggregateRatingContract, RatingContract, IntangibleContract, ThingContract { /** - * The item that is being reviewed/rated. - * - * @param Thing|Thing[] $itemReviewed - * - * @return static - * - * @see http://schema.org/itemReviewed - */ - public function itemReviewed($itemReviewed) - { - return $this->setProperty('itemReviewed', $itemReviewed); - } - - /** - * The count of total number of ratings. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param int|int[] $ratingCount + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/ratingCount + * @see http://schema.org/additionalType */ - public function ratingCount($ratingCount) + public function additionalType($additionalType) { - return $this->setProperty('ratingCount', $ratingCount); + return $this->setProperty('additionalType', $additionalType); } /** - * The count of total number of reviews. + * An alias for the item. * - * @param int|int[] $reviewCount + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/reviewCount + * @see http://schema.org/alternateName */ - public function reviewCount($reviewCount) + public function alternateName($alternateName) { - return $this->setProperty('reviewCount', $reviewCount); + return $this->setProperty('alternateName', $alternateName); } /** @@ -88,90 +79,6 @@ public function bestRating($bestRating) return $this->setProperty('bestRating', $bestRating); } - /** - * The rating for the content. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param float|float[]|int|int[]|string|string[] $ratingValue - * - * @return static - * - * @see http://schema.org/ratingValue - */ - public function ratingValue($ratingValue) - { - return $this->setProperty('ratingValue', $ratingValue); - } - - /** - * This Review or Rating is relevant to this part or facet of the - * itemReviewed. - * - * @param string|string[] $reviewAspect - * - * @return static - * - * @see http://schema.org/reviewAspect - */ - public function reviewAspect($reviewAspect) - { - return $this->setProperty('reviewAspect', $reviewAspect); - } - - /** - * The lowest value allowed in this rating system. If worstRating is - * omitted, 1 is assumed. - * - * @param float|float[]|int|int[]|string|string[] $worstRating - * - * @return static - * - * @see http://schema.org/worstRating - */ - public function worstRating($worstRating) - { - return $this->setProperty('worstRating', $worstRating); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - /** * A description of the item. * @@ -236,6 +143,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The item that is being reviewed/rated. + * + * @param Thing|Thing[] $itemReviewed + * + * @return static + * + * @see http://schema.org/itemReviewed + */ + public function itemReviewed($itemReviewed) + { + return $this->setProperty('itemReviewed', $itemReviewed); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -281,6 +202,70 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The count of total number of ratings. + * + * @param int|int[] $ratingCount + * + * @return static + * + * @see http://schema.org/ratingCount + */ + public function ratingCount($ratingCount) + { + return $this->setProperty('ratingCount', $ratingCount); + } + + /** + * The rating for the content. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $ratingValue + * + * @return static + * + * @see http://schema.org/ratingValue + */ + public function ratingValue($ratingValue) + { + return $this->setProperty('ratingValue', $ratingValue); + } + + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + + /** + * The count of total number of reviews. + * + * @param int|int[] $reviewCount + * + * @return static + * + * @see http://schema.org/reviewCount + */ + public function reviewCount($reviewCount) + { + return $this->setProperty('reviewCount', $reviewCount); + } + /** * 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 @@ -325,4 +310,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The lowest value allowed in this rating system. If worstRating is + * omitted, 1 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $worstRating + * + * @return static + * + * @see http://schema.org/worstRating + */ + public function worstRating($worstRating) + { + return $this->setProperty('worstRating', $worstRating); + } + } diff --git a/src/EmploymentAgency.php b/src/EmploymentAgency.php index 8397231e6..2cc4398a2 100644 --- a/src/EmploymentAgency.php +++ b/src/EmploymentAgency.php @@ -16,126 +16,104 @@ class EmploymentAgency extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/EndorseAction.php b/src/EndorseAction.php index c13ab940a..268eb2cd3 100644 --- a/src/EndorseAction.php +++ b/src/EndorseAction.php @@ -16,31 +16,36 @@ class EndorseAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The person/organization being supported. + * Indicates the current disposition of the Action. * - * @param Organization|Organization[]|Person|Person[] $endorsee + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/endorsee + * @see http://schema.org/actionStatus */ - public function endorsee($endorsee) + public function actionStatus($actionStatus) { - return $this->setProperty('endorsee', $endorsee); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -59,325 +64,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of participant. The person/organization being supported. * - * @param Thing|Thing[] $object + * @param Organization|Organization[]|Person|Person[] $endorsee * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endorsee */ - public function object($object) + public function endorsee($endorsee) { - return $this->setProperty('object', $object); + return $this->setProperty('endorsee', $endorsee); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/EndorsementRating.php b/src/EndorsementRating.php index c0b5c4737..d17e9b6bc 100644 --- a/src/EndorsementRating.php +++ b/src/EndorsementRating.php @@ -27,118 +27,67 @@ class EndorsementRating extends BaseType implements RatingContract, IntangibleContract, ThingContract { /** - * The author of this content or rating. Please note that author is special - * in that HTML 5 provides a special mechanism for indicating authorship via - * the rel tag. That is equivalent to this and may be used interchangeably. - * - * @param Organization|Organization[]|Person|Person[] $author - * - * @return static - * - * @see http://schema.org/author - */ - public function author($author) - { - return $this->setProperty('author', $author); - } - - /** - * The highest value allowed in this rating system. If bestRating is - * omitted, 5 is assumed. - * - * @param float|float[]|int|int[]|string|string[] $bestRating - * - * @return static - * - * @see http://schema.org/bestRating - */ - public function bestRating($bestRating) - { - return $this->setProperty('bestRating', $bestRating); - } - - /** - * The rating for the content. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param float|float[]|int|int[]|string|string[] $ratingValue - * - * @return static - * - * @see http://schema.org/ratingValue - */ - public function ratingValue($ratingValue) - { - return $this->setProperty('ratingValue', $ratingValue); - } - - /** - * This Review or Rating is relevant to this part or facet of the - * itemReviewed. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $reviewAspect + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/reviewAspect + * @see http://schema.org/additionalType */ - public function reviewAspect($reviewAspect) + public function additionalType($additionalType) { - return $this->setProperty('reviewAspect', $reviewAspect); + return $this->setProperty('additionalType', $additionalType); } /** - * The lowest value allowed in this rating system. If worstRating is - * omitted, 1 is assumed. + * An alias for the item. * - * @param float|float[]|int|int[]|string|string[] $worstRating + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/worstRating + * @see http://schema.org/alternateName */ - public function worstRating($worstRating) + public function alternateName($alternateName) { - return $this->setProperty('worstRating', $worstRating); + return $this->setProperty('alternateName', $alternateName); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $author * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/author */ - public function additionalType($additionalType) + public function author($author) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('author', $author); } /** - * An alias for the item. + * The highest value allowed in this rating system. If bestRating is + * omitted, 5 is assumed. * - * @param string|string[] $alternateName + * @param float|float[]|int|int[]|string|string[] $bestRating * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/bestRating */ - public function alternateName($alternateName) + public function bestRating($bestRating) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('bestRating', $bestRating); } /** @@ -250,6 +199,42 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The rating for the content. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $ratingValue + * + * @return static + * + * @see http://schema.org/ratingValue + */ + public function ratingValue($ratingValue) + { + return $this->setProperty('ratingValue', $ratingValue); + } + + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + /** * 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 @@ -294,4 +279,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The lowest value allowed in this rating system. If worstRating is + * omitted, 1 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $worstRating + * + * @return static + * + * @see http://schema.org/worstRating + */ + public function worstRating($worstRating) + { + return $this->setProperty('worstRating', $worstRating); + } + } diff --git a/src/EngineSpecification.php b/src/EngineSpecification.php index 53c23a01d..2118c9b3d 100644 --- a/src/EngineSpecification.php +++ b/src/EngineSpecification.php @@ -15,22 +15,6 @@ */ class EngineSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { - /** - * The type of fuel suitable for the engine or engines of the vehicle. If - * the vehicle has only one engine, this property can be attached directly - * to the vehicle. - * - * @param QualitativeValue|QualitativeValue[]|string|string[] $fuelType - * - * @return static - * - * @see http://schema.org/fuelType - */ - public function fuelType($fuelType) - { - return $this->setProperty('fuelType', $fuelType); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -95,6 +79,22 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The type of fuel suitable for the engine or engines of the vehicle. If + * the vehicle has only one engine, this property can be attached directly + * to the vehicle. + * + * @param QualitativeValue|QualitativeValue[]|string|string[] $fuelType + * + * @return static + * + * @see http://schema.org/fuelType + */ + public function fuelType($fuelType) + { + return $this->setProperty('fuelType', $fuelType); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides diff --git a/src/EntertainmentBusiness.php b/src/EntertainmentBusiness.php index 80e153e57..f2d57b402 100644 --- a/src/EntertainmentBusiness.php +++ b/src/EntertainmentBusiness.php @@ -16,126 +16,104 @@ class EntertainmentBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/EntryPoint.php b/src/EntryPoint.php index fd289ce64..db669c2e6 100644 --- a/src/EntryPoint.php +++ b/src/EntryPoint.php @@ -44,139 +44,124 @@ public function actionPlatform($actionPlatform) } /** - * An application that can complete the request. - * - * @param SoftwareApplication|SoftwareApplication[] $application - * - * @return static - * - * @see http://schema.org/application - */ - public function application($application) - { - return $this->setProperty('application', $application); - } - - /** - * The supported content type(s) for an EntryPoint response. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $contentType + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/contentType + * @see http://schema.org/additionalType */ - public function contentType($contentType) + public function additionalType($additionalType) { - return $this->setProperty('contentType', $contentType); + return $this->setProperty('additionalType', $additionalType); } /** - * The supported encoding type(s) for an EntryPoint request. + * An alias for the item. * - * @param string|string[] $encodingType + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/encodingType + * @see http://schema.org/alternateName */ - public function encodingType($encodingType) + public function alternateName($alternateName) { - return $this->setProperty('encodingType', $encodingType); + return $this->setProperty('alternateName', $alternateName); } /** - * An HTTP method that specifies the appropriate HTTP method for a request - * to an HTTP EntryPoint. Values are capitalized strings as used in HTTP. + * An application that can complete the request. * - * @param string|string[] $httpMethod + * @param SoftwareApplication|SoftwareApplication[] $application * * @return static * - * @see http://schema.org/httpMethod + * @see http://schema.org/application */ - public function httpMethod($httpMethod) + public function application($application) { - return $this->setProperty('httpMethod', $httpMethod); + return $this->setProperty('application', $application); } /** - * An url template (RFC6570) that will be used to construct the target of - * the execution of the action. + * The supported content type(s) for an EntryPoint response. * - * @param string|string[] $urlTemplate + * @param string|string[] $contentType * * @return static * - * @see http://schema.org/urlTemplate + * @see http://schema.org/contentType */ - public function urlTemplate($urlTemplate) + public function contentType($contentType) { - return $this->setProperty('urlTemplate', $urlTemplate); + return $this->setProperty('contentType', $contentType); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * A description of the item. * - * @param string|string[] $additionalType + * @param string|string[] $description * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/description */ - public function additionalType($additionalType) + public function description($description) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('description', $description); } /** - * An alias for the item. + * 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. * - * @param string|string[] $alternateName + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/disambiguatingDescription */ - public function alternateName($alternateName) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A description of the item. + * The supported encoding type(s) for an EntryPoint request. * - * @param string|string[] $description + * @param string|string[] $encodingType * * @return static * - * @see http://schema.org/description + * @see http://schema.org/encodingType */ - public function description($description) + public function encodingType($encodingType) { - return $this->setProperty('description', $description); + return $this->setProperty('encodingType', $encodingType); } /** - * 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. + * An HTTP method that specifies the appropriate HTTP method for a request + * to an HTTP EntryPoint. Values are capitalized strings as used in HTTP. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $httpMethod * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/httpMethod */ - public function disambiguatingDescription($disambiguatingDescription) + public function httpMethod($httpMethod) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('httpMethod', $httpMethod); } /** @@ -301,4 +286,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * An url template (RFC6570) that will be used to construct the target of + * the execution of the action. + * + * @param string|string[] $urlTemplate + * + * @return static + * + * @see http://schema.org/urlTemplate + */ + public function urlTemplate($urlTemplate) + { + return $this->setProperty('urlTemplate', $urlTemplate); + } + } diff --git a/src/Episode.php b/src/Episode.php index 815eda84c..e430e371c 100644 --- a/src/Episode.php +++ b/src/Episode.php @@ -14,153 +14,6 @@ */ class Episode extends BaseType implements CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * Position of the episode within an ordered group of episodes. - * - * @param int|int[]|string|string[] $episodeNumber - * - * @return static - * - * @see http://schema.org/episodeNumber - */ - public function episodeNumber($episodeNumber) - { - return $this->setProperty('episodeNumber', $episodeNumber); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The season to which this episode belongs. - * - * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason - * - * @return static - * - * @see http://schema.org/partOfSeason - */ - public function partOfSeason($partOfSeason) - { - return $this->setProperty('partOfSeason', $partOfSeason); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The trailer of a movie or tv/radio series, season, episode, etc. - * - * @param VideoObject|VideoObject[] $trailer - * - * @return static - * - * @see http://schema.org/trailer - */ - public function trailer($trailer) - { - return $this->setProperty('trailer', $trailer); - } - /** * The subject matter of the content. * @@ -305,6 +158,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -320,6 +223,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -612,58 +529,120 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * 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. * - * @param string|string[] $educationalUse + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/disambiguatingDescription */ - public function educationalUse($educationalUse) + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) { return $this->setProperty('educationalUse', $educationalUse); } @@ -724,6 +703,20 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * Position of the episode within an ordered group of episodes. + * + * @param int|int[]|string|string[] $episodeNumber + * + * @return static + * + * @see http://schema.org/episodeNumber + */ + public function episodeNumber($episodeNumber) + { + return $this->setProperty('episodeNumber', $episodeNumber); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -836,6 +829,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1033,6 +1059,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1063,6 +1105,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1079,6 +1149,34 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1093,6 +1191,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1108,6 +1221,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1234,6 +1362,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1316,6 +1460,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1407,6 +1565,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1437,6 +1609,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1480,190 +1666,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Event.php b/src/Event.php index 15429d59b..451ed64fd 100644 --- a/src/Event.php +++ b/src/Event.php @@ -44,6 +44,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -59,6 +78,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -130,6 +163,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -146,6 +193,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -220,6 +284,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -266,6 +363,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -280,6 +393,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -340,6 +467,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -400,6 +542,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -462,6 +620,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -508,6 +680,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -539,190 +725,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/EventReservation.php b/src/EventReservation.php index 552397aa0..ea0fa63c3 100644 --- a/src/EventReservation.php +++ b/src/EventReservation.php @@ -18,6 +18,39 @@ */ class EventReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as * a booking agent. @@ -65,335 +98,302 @@ public function broker($broker) } /** - * The date and time the reservation was modified. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/description */ - public function modifiedTime($modifiedTime) + public function description($description) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('description', $description); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. * - * @param string|string[] $priceCurrency + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/disambiguatingDescription */ - public function priceCurrency($priceCurrency) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/identifier */ - public function programMembershipUsed($programMembershipUsed) + public function identifier($identifier) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('identifier', $identifier); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/image */ - public function provider($provider) + public function image($image) { - return $this->setProperty('provider', $provider); + return $this->setProperty('image', $image); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $reservationFor + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/mainEntityOfPage */ - public function reservationFor($reservationFor) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A unique identifier for the reservation. + * The date and time the reservation was modified. * - * @param string|string[] $reservationId + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/modifiedTime */ - public function reservationId($reservationId) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The current status of the reservation. + * The name of the item. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/name */ - public function reservationStatus($reservationStatus) + public function name($name) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('name', $name); } /** - * A ticket associated with the reservation. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Ticket|Ticket[] $reservedTicket + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/potentialAction */ - public function reservedTicket($reservedTicket) + public function potentialAction($potentialAction) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice - * - * @return static - * - * @see http://schema.org/totalPrice - */ - public function totalPrice($totalPrice) - { - return $this->setProperty('totalPrice', $totalPrice); - } - - /** - * The person or organization the reservation or ticket is for. - * - * @param Organization|Organization[]|Person|Person[] $underName - * - * @return static - * - * @see http://schema.org/underName - */ - public function underName($underName) - { - return $this->setProperty('underName', $underName); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $additionalType + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/priceCurrency */ - public function additionalType($additionalType) + public function priceCurrency($priceCurrency) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An alias for the item. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $alternateName + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/programMembershipUsed */ - public function alternateName($alternateName) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * A description of the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/description + * @see http://schema.org/provider */ - public function description($description) + public function provider($provider) { - return $this->setProperty('description', $description); + return $this->setProperty('provider', $provider); } /** - * 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. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/reservationFor */ - public function disambiguatingDescription($disambiguatingDescription) + public function reservationFor($reservationFor) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('reservationFor', $reservationFor); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A unique identifier for the reservation. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reservationId */ - public function identifier($identifier) + public function reservationId($reservationId) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reservationId', $reservationId); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The current status of the reservation. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservationStatus */ - public function image($image) + public function reservationStatus($reservationStatus) { - return $this->setProperty('image', $image); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A ticket associated with the reservation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/reservedTicket */ - public function mainEntityOfPage($mainEntityOfPage) + public function reservedTicket($reservedTicket) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('reservedTicket', $reservedTicket); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param string|string[] $sameAs + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/totalPrice */ - public function sameAs($sameAs) + public function totalPrice($totalPrice) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('totalPrice', $totalPrice); } /** - * A CreativeWork or Event about this Thing. + * The person or organization the reservation or ticket is for. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Organization|Organization[]|Person|Person[] $underName * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/underName */ - public function subjectOf($subjectOf) + public function underName($underName) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('underName', $underName); } /** diff --git a/src/EventVenue.php b/src/EventVenue.php index 27970fd4e..2c880024c 100644 --- a/src/EventVenue.php +++ b/src/EventVenue.php @@ -14,35 +14,6 @@ */ class EventVenue extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/ExerciseAction.php b/src/ExerciseAction.php index cfbee6b83..127311a08 100644 --- a/src/ExerciseAction.php +++ b/src/ExerciseAction.php @@ -16,147 +16,175 @@ class ExerciseAction extends BaseType implements PlayActionContract, ActionContract, ThingContract { /** - * A sub property of location. The course where this action was taken. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $course + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/course + * @see http://schema.org/actionStatus */ - public function course($course) + public function actionStatus($actionStatus) { - return $this->setProperty('course', $course); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The distance travelled, e.g. exercising or travelling. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Distance|Distance[] $distance + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/distance + * @see http://schema.org/additionalType */ - public function distance($distance) + public function additionalType($additionalType) { - return $this->setProperty('distance', $distance); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of location. The course where this action was taken. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Place|Place[] $exerciseCourse + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/exerciseCourse + * @see http://schema.org/agent */ - public function exerciseCourse($exerciseCourse) + public function agent($agent) { - return $this->setProperty('exerciseCourse', $exerciseCourse); + return $this->setProperty('agent', $agent); } /** - * A sub property of location. The original location of the object or the - * agent before the action. + * An alias for the item. * - * @param Place|Place[] $fromLocation + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/alternateName */ - public function fromLocation($fromLocation) + public function alternateName($alternateName) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('alternateName', $alternateName); } /** - * A sub property of participant. The opponent on this action. + * An intended audience, i.e. a group for whom something was created. * - * @param Person|Person[] $opponent + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/opponent + * @see http://schema.org/audience */ - public function opponent($opponent) + public function audience($audience) { - return $this->setProperty('opponent', $opponent); + return $this->setProperty('audience', $audience); } /** - * A sub property of location. The sports activity location where this - * action occurred. + * A sub property of location. The course where this action was taken. * - * @param SportsActivityLocation|SportsActivityLocation[] $sportsActivityLocation + * @param Place|Place[] $course * * @return static * - * @see http://schema.org/sportsActivityLocation + * @see http://schema.org/course */ - public function sportsActivityLocation($sportsActivityLocation) + public function course($course) { - return $this->setProperty('sportsActivityLocation', $sportsActivityLocation); + return $this->setProperty('course', $course); } /** - * A sub property of location. The sports event where this action occurred. + * A description of the item. * - * @param SportsEvent|SportsEvent[] $sportsEvent + * @param string|string[] $description * * @return static * - * @see http://schema.org/sportsEvent + * @see http://schema.org/description */ - public function sportsEvent($sportsEvent) + public function description($description) { - return $this->setProperty('sportsEvent', $sportsEvent); + return $this->setProperty('description', $description); } /** - * A sub property of participant. The sports team that participated on this - * action. + * 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. * - * @param SportsTeam|SportsTeam[] $sportsTeam + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/sportsTeam + * @see http://schema.org/disambiguatingDescription */ - public function sportsTeam($sportsTeam) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('sportsTeam', $sportsTeam); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * The distance travelled, e.g. exercising or travelling. * - * @param Place|Place[] $toLocation + * @param Distance|Distance[] $distance * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/distance */ - public function toLocation($toLocation) + public function distance($distance) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('distance', $distance); } /** - * An intended audience, i.e. a group for whom something was created. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Audience|Audience[] $audience + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/endTime */ - public function audience($audience) + public function endTime($endTime) { - return $this->setProperty('audience', $audience); + return $this->setProperty('endTime', $endTime); + } + + /** + * For failed actions, more information on the cause of the failure. + * + * @param Thing|Thing[] $error + * + * @return static + * + * @see http://schema.org/error + */ + public function error($error) + { + return $this->setProperty('error', $error); } /** @@ -175,69 +203,65 @@ public function event($event) } /** - * Indicates the current disposition of the Action. + * A sub property of location. The course where this action was taken. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Place|Place[] $exerciseCourse * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/exerciseCourse */ - public function actionStatus($actionStatus) + public function exerciseCourse($exerciseCourse) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('exerciseCourse', $exerciseCourse); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/fromLocation */ - public function agent($agent) + public function fromLocation($fromLocation) { - return $this->setProperty('agent', $agent); + return $this->setProperty('fromLocation', $fromLocation); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/identifier */ - public function endTime($endTime) + public function identifier($identifier) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('identifier', $identifier); } /** - * For failed actions, more information on the cause of the failure. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $error + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/error + * @see http://schema.org/image */ - public function error($error) + public function image($image) { - return $this->setProperty('error', $error); + return $this->setProperty('image', $image); } /** @@ -271,258 +295,234 @@ public function location($location) } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. - * - * @param Thing|Thing[] $object - * - * @return static - * - * @see http://schema.org/object - */ - public function object($object) - { - return $this->setProperty('object', $object); - } - - /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/mainEntityOfPage */ - public function participant($participant) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The name of the item. * - * @param Thing|Thing[] $result + * @param string|string[] $name * * @return static * - * @see http://schema.org/result + * @see http://schema.org/name */ - public function result($result) + public function name($name) { - return $this->setProperty('result', $result); + return $this->setProperty('name', $name); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/object */ - public function startTime($startTime) + public function object($object) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('object', $object); } /** - * Indicates a target EntryPoint for an Action. + * A sub property of participant. The opponent on this action. * - * @param EntryPoint|EntryPoint[] $target + * @param Person|Person[] $opponent * * @return static * - * @see http://schema.org/target + * @see http://schema.org/opponent */ - public function target($target) + public function opponent($opponent) { - return $this->setProperty('target', $target); + return $this->setProperty('opponent', $opponent); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/participant */ - public function additionalType($additionalType) + public function participant($participant) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('participant', $participant); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The result produced in the action. e.g. John wrote *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/description + * @see http://schema.org/result */ - public function description($description) + public function result($result) { - return $this->setProperty('description', $description); + return $this->setProperty('result', $result); } /** - * 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. + * 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. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/sameAs */ - public function disambiguatingDescription($disambiguatingDescription) + public function sameAs($sameAs) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('sameAs', $sameAs); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of location. The sports activity location where this + * action occurred. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param SportsActivityLocation|SportsActivityLocation[] $sportsActivityLocation * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sportsActivityLocation */ - public function identifier($identifier) + public function sportsActivityLocation($sportsActivityLocation) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sportsActivityLocation', $sportsActivityLocation); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of location. The sports event where this action occurred. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param SportsEvent|SportsEvent[] $sportsEvent * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sportsEvent */ - public function image($image) + public function sportsEvent($sportsEvent) { - return $this->setProperty('image', $image); + return $this->setProperty('sportsEvent', $sportsEvent); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A sub property of participant. The sports team that participated on this + * action. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param SportsTeam|SportsTeam[] $sportsTeam * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sportsTeam */ - public function mainEntityOfPage($mainEntityOfPage) + public function sportsTeam($sportsTeam) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sportsTeam', $sportsTeam); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/ExerciseGym.php b/src/ExerciseGym.php index b9162462a..616534417 100644 --- a/src/ExerciseGym.php +++ b/src/ExerciseGym.php @@ -17,126 +17,104 @@ class ExerciseGym extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ExhibitionEvent.php b/src/ExhibitionEvent.php index be28c0e07..0c8dca780 100644 --- a/src/ExhibitionEvent.php +++ b/src/ExhibitionEvent.php @@ -44,6 +44,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -59,6 +78,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -130,6 +163,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -146,6 +193,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -220,6 +284,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -266,6 +363,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -280,6 +393,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -340,6 +467,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -400,6 +542,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -462,6 +620,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -508,6 +680,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -539,190 +725,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/FAQPage.php b/src/FAQPage.php index cbaace087..ec82861f4 100644 --- a/src/FAQPage.php +++ b/src/FAQPage.php @@ -15,176 +15,6 @@ */ class FAQPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -329,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -344,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -445,6 +308,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -635,6 +513,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -861,13 +770,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -997,6 +939,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1042,6 +999,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1057,6 +1028,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1087,6 +1074,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1117,6 +1118,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1215,6 +1245,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1244,6 +1288,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1258,6 +1317,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1275,6 +1350,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1324,6 +1429,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1340,6 +1498,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1461,6 +1633,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1504,190 +1690,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/FMRadioChannel.php b/src/FMRadioChannel.php index fc961bb61..42b90316c 100644 --- a/src/FMRadioChannel.php +++ b/src/FMRadioChannel.php @@ -15,6 +15,39 @@ */ class FMRadioChannel extends BaseType implements RadioChannelContract, BroadcastChannelContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The unique address by which the BroadcastService can be identified in a * provider lineup. In US, this is typically a number. @@ -61,81 +94,6 @@ public function broadcastServiceTier($broadcastServiceTier) return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); } - /** - * Genre of the creative work, broadcast channel or group. - * - * @param string|string[] $genre - * - * @return static - * - * @see http://schema.org/genre - */ - public function genre($genre) - { - return $this->setProperty('genre', $genre); - } - - /** - * The CableOrSatelliteService offering the channel. - * - * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup - * - * @return static - * - * @see http://schema.org/inBroadcastLineup - */ - public function inBroadcastLineup($inBroadcastLineup) - { - return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); - } - - /** - * The BroadcastService offered on this channel. - * - * @param BroadcastService|BroadcastService[] $providesBroadcastService - * - * @return static - * - * @see http://schema.org/providesBroadcastService - */ - public function providesBroadcastService($providesBroadcastService) - { - return $this->setProperty('providesBroadcastService', $providesBroadcastService); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - /** * A description of the item. * @@ -167,6 +125,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -200,6 +172,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -245,6 +231,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + /** * 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 diff --git a/src/FastFoodRestaurant.php b/src/FastFoodRestaurant.php index d5c37a75c..f97fc63fd 100644 --- a/src/FastFoodRestaurant.php +++ b/src/FastFoodRestaurant.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Festival.php b/src/Festival.php index a9065bf18..5887a3b0e 100644 --- a/src/Festival.php +++ b/src/Festival.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/FilmAction.php b/src/FilmAction.php index 3d4c24d84..7dd6dbc6b 100644 --- a/src/FilmAction.php +++ b/src/FilmAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/FinancialProduct.php b/src/FinancialProduct.php index 2cb9c1e6c..a8780be59 100644 --- a/src/FinancialProduct.php +++ b/src/FinancialProduct.php @@ -17,65 +17,68 @@ class FinancialProduct extends BaseType implements ServiceContract, IntangibleContract, ThingContract { /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/additionalType */ - public function annualPercentageRate($annualPercentageRate) + public function additionalType($additionalType) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('additionalType', $additionalType); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/aggregateRating */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function aggregateRating($aggregateRating) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/alternateName */ - public function interestRate($interestRate) + public function alternateName($alternateName) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/annualPercentageRate */ - public function aggregateRating($aggregateRating) + public function annualPercentageRate($annualPercentageRate) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -183,380 +186,377 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * A description of the item. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/description */ - public function hasOfferCatalog($hasOfferCatalog) + public function description($description) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('description', $description); } /** - * The hours during which this service or contact is available. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/disambiguatingDescription */ - public function hoursAvailable($hoursAvailable) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, somehow related product (or multiple products). + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param string|string[] $feesAndCommissionsSpecification * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/feesAndCommissionsSpecification */ - public function isRelatedTo($isRelatedTo) + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/hasOfferCatalog */ - public function isSimilarTo($isSimilarTo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An associated logo. + * The hours during which this service or contact is available. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hoursAvailable */ - public function logo($logo) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $offers + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/identifier */ - public function offers($offers) + public function identifier($identifier) { - return $this->setProperty('offers', $offers); + return $this->setProperty('identifier', $identifier); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $produces + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/image */ - public function produces($produces) + public function image($image) { - return $this->setProperty('produces', $produces); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/interestRate */ - public function provider($provider) + public function interestRate($interestRate) { - return $this->setProperty('provider', $provider); + return $this->setProperty('interestRate', $interestRate); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * A pointer to another, somehow related product (or multiple products). * - * @param string|string[] $providerMobility + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/isRelatedTo */ - public function providerMobility($providerMobility) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * A review of the item. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param Review|Review[] $review + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/isSimilarTo */ - public function review($review) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('review', $review); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * The geographic area where the service is provided. + * An associated logo. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/logo */ - public function serviceArea($serviceArea) + public function logo($logo) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('logo', $logo); } /** - * The audience eligible for this service. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Audience|Audience[] $serviceAudience + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/mainEntityOfPage */ - public function serviceAudience($serviceAudience) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * The name of the item. * - * @param Thing|Thing[] $serviceOutput + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/name */ - public function serviceOutput($serviceOutput) + public function name($name) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('name', $name); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param string|string[] $serviceType + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/offers */ - public function serviceType($serviceType) + public function offers($offers) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('offers', $offers); } /** - * A slogan or motto associated with the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $slogan + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/potentialAction */ - public function slogan($slogan) + public function potentialAction($potentialAction) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/produces */ - public function additionalType($additionalType) + public function produces($produces) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('produces', $produces); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $description + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/description + * @see http://schema.org/providerMobility */ - public function description($description) + public function providerMobility($providerMobility) { - return $this->setProperty('description', $description); + return $this->setProperty('providerMobility', $providerMobility); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** diff --git a/src/FinancialService.php b/src/FinancialService.php index 8430fc247..dc8d2cb97 100644 --- a/src/FinancialService.php +++ b/src/FinancialService.php @@ -16,183 +16,181 @@ class FinancialService extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $feesAndCommissionsSpecification + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/additionalProperty */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function additionalProperty($additionalProperty) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/additionalType */ - public function branchOf($branchOf) + public function additionalType($additionalType) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Physical address of the item. * - * @param string|string[] $currenciesAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/address */ - public function currenciesAccepted($currenciesAccepted) + public function address($address) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('address', $address); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $openingHours + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/aggregateRating */ - public function openingHours($openingHours) + public function aggregateRating($aggregateRating) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * An alias for the item. * - * @param string|string[] $paymentAccepted + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/alternateName */ - public function paymentAccepted($paymentAccepted) + public function alternateName($alternateName) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('alternateName', $alternateName); } /** - * The price range of the business, for example ```$$$```. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $priceRange + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/amenityFeature */ - public function priceRange($priceRange) + public function amenityFeature($amenityFeature) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Physical address of the item. + * The geographic area where a service or offered item is provided. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/address + * @see http://schema.org/areaServed */ - public function address($address) + public function areaServed($areaServed) { - return $this->setProperty('address', $address); + return $this->setProperty('areaServed', $areaServed); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An award won by or for this item. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $award * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/award */ - public function aggregateRating($aggregateRating) + public function award($award) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('award', $award); } /** - * The geographic area where a service or offered item is provided. + * Awards won by or for this item. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param string|string[] $awards * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/awards */ - public function areaServed($areaServed) + public function awards($awards) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('awards', $awards); } /** - * An award won by or for this item. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param string|string[] $award + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/award + * @see http://schema.org/branchCode */ - public function award($award) + public function branchCode($branchCode) { - return $this->setProperty('award', $award); + return $this->setProperty('branchCode', $branchCode); } /** - * Awards won by or for this item. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $awards + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/branchOf */ - public function awards($awards) + public function branchOf($branchOf) { - return $this->setProperty('awards', $awards); + return $this->setProperty('branchOf', $branchOf); } /** @@ -238,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -255,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -369,6 +463,21 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + /** * A person who founded this organization. * @@ -440,6 +549,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -457,6 +580,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -486,6 +623,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -502,6 +686,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -560,6 +759,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -574,6 +804,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -633,6 +905,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -661,6 +947,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -691,664 +1020,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/photos */ - public function reviews($reviews) + public function photos($photos) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Demand|Demand[] $seeks + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/potentialAction */ - public function seeks($seeks) + public function potentialAction($potentialAction) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The geographic area where the service is provided. + * The price range of the business, for example ```$$$```. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/priceRange */ - public function serviceArea($serviceArea) + public function priceRange($priceRange) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('priceRange', $priceRange); } /** - * A slogan or motto associated with the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $slogan + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/publicAccess */ - public function slogan($slogan) + public function publicAccess($publicAccess) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/publishingPrinciples */ - public function sponsor($sponsor) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A review of the item. * - * @param Organization|Organization[] $subOrganization + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/review */ - public function subOrganization($subOrganization) + public function review($review) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('review', $review); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * Review of the item. * - * @param string|string[] $taxID + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/reviews */ - public function taxID($taxID) + public function reviews($reviews) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('reviews', $reviews); } /** - * The telephone number. + * 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. * - * @param string|string[] $telephone + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/sameAs */ - public function telephone($telephone) + public function sameAs($sameAs) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('sameAs', $sameAs); } /** - * The Value-added Tax ID of the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param string|string[] $vatID + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/seeks */ - public function vatID($vatID) + public function seeks($seeks) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('seeks', $seeks); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geographic area where the service is provided. * - * @param string|string[] $additionalType + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/serviceArea */ - public function additionalType($additionalType) + public function serviceArea($serviceArea) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('serviceArea', $serviceArea); } /** - * An alias for the item. + * A slogan or motto associated with the item. * - * @param string|string[] $alternateName + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/slogan */ - public function alternateName($alternateName) + public function slogan($slogan) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('slogan', $slogan); } /** - * A description of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $description + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/description + * @see http://schema.org/smokingAllowed */ - public function description($description) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('description', $description); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * 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. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $disambiguatingDescription + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/specialOpeningHoursSpecification */ - public function disambiguatingDescription($disambiguatingDescription) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sponsor */ - public function identifier($identifier) + public function sponsor($sponsor) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sponsor', $sponsor); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/image + * @see http://schema.org/subOrganization */ - public function image($image) + public function subOrganization($subOrganization) { - return $this->setProperty('image', $image); + return $this->setProperty('subOrganization', $subOrganization); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A CreativeWork or Event about this Thing. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/subjectOf */ - public function mainEntityOfPage($mainEntityOfPage) + public function subjectOf($subjectOf) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('subjectOf', $subjectOf); } /** - * The name of the item. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param string|string[] $name + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/name + * @see http://schema.org/taxID */ - public function name($name) + public function taxID($taxID) { - return $this->setProperty('name', $name); + return $this->setProperty('taxID', $taxID); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The telephone number. * - * @param Action|Action[] $potentialAction + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/telephone */ - public function potentialAction($potentialAction) + public function telephone($telephone) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('telephone', $telephone); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The Value-added Tax ID of the organization or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/vatID */ - public function subjectOf($subjectOf) + public function vatID($vatID) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty - * - * @return static - * - * @see http://schema.org/additionalProperty - */ - public function additionalProperty($additionalProperty) - { - return $this->setProperty('additionalProperty', $additionalProperty); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. - * - * @param string|string[] $branchCode - * - * @return static - * - * @see http://schema.org/branchCode - */ - public function branchCode($branchCode) - { - return $this->setProperty('branchCode', $branchCode); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedIn - * - * @return static - * - * @see http://schema.org/containedIn - */ - public function containedIn($containedIn) - { - return $this->setProperty('containedIn', $containedIn); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedInPlace - * - * @return static - * - * @see http://schema.org/containedInPlace - */ - public function containedInPlace($containedInPlace) - { - return $this->setProperty('containedInPlace', $containedInPlace); - } - - /** - * The basic containment relation between a place and another that it - * contains. - * - * @param Place|Place[] $containsPlace - * - * @return static - * - * @see http://schema.org/containsPlace - */ - public function containsPlace($containsPlace) - { - return $this->setProperty('containsPlace', $containsPlace); - } - - /** - * The geo coordinates of the place. - * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo - * - * @return static - * - * @see http://schema.org/geo - */ - public function geo($geo) - { - return $this->setProperty('geo', $geo); - } - - /** - * A URL to a map of the place. - * - * @param Map|Map[]|string|string[] $hasMap - * - * @return static - * - * @see http://schema.org/hasMap - */ - public function hasMap($hasMap) - { - return $this->setProperty('hasMap', $hasMap); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $latitude - * - * @return static - * - * @see http://schema.org/latitude - */ - public function latitude($latitude) - { - return $this->setProperty('latitude', $latitude); - } - - /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $longitude - * - * @return static - * - * @see http://schema.org/longitude - */ - public function longitude($longitude) - { - return $this->setProperty('longitude', $longitude); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $map - * - * @return static - * - * @see http://schema.org/map - */ - public function map($map) - { - return $this->setProperty('map', $map); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $maps - * - * @return static - * - * @see http://schema.org/maps - */ - public function maps($maps) - { - return $this->setProperty('maps', $maps); - } - - /** - * The total number of individuals that may attend an event or venue. - * - * @param int|int[] $maximumAttendeeCapacity - * - * @return static - * - * @see http://schema.org/maximumAttendeeCapacity - */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) - { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); - } - - /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. - * - * @param bool|bool[] $smokingAllowed - * - * @return static - * - * @see http://schema.org/smokingAllowed - */ - public function smokingAllowed($smokingAllowed) - { - return $this->setProperty('smokingAllowed', $smokingAllowed); - } - - /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification - * - * @return static - * - * @see http://schema.org/specialOpeningHoursSpecification - */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) - { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/FindAction.php b/src/FindAction.php index 103b87311..da12aa580 100644 --- a/src/FindAction.php +++ b/src/FindAction.php @@ -33,340 +33,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/FireStation.php b/src/FireStation.php index b03368bf4..96407fb13 100644 --- a/src/FireStation.php +++ b/src/FireStation.php @@ -17,35 +17,6 @@ */ class FireStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -68,6 +39,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -97,6 +87,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -115,479 +119,495 @@ public function amenityFeature($amenityFeature) } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The geographic area where a service or offered item is provided. * - * @param string|string[] $branchCode + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/areaServed */ - public function branchCode($branchCode) + public function areaServed($areaServed) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('areaServed', $areaServed); } /** - * The basic containment relation between a place and one that contains it. + * An award won by or for this item. * - * @param Place|Place[] $containedIn + * @param string|string[] $award * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/award */ - public function containedIn($containedIn) + public function award($award) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('award', $award); } /** - * The basic containment relation between a place and one that contains it. + * Awards won by or for this item. * - * @param Place|Place[] $containedInPlace + * @param string|string[] $awards * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/awards */ - public function containedInPlace($containedInPlace) + public function awards($awards) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('awards', $awards); } /** - * The basic containment relation between a place and another that it - * contains. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/branchCode */ - public function containsPlace($containsPlace) + public function branchCode($branchCode) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('branchCode', $branchCode); } /** - * Upcoming or past event associated with this place, organization, or - * action. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param Event|Event[] $event + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/event + * @see http://schema.org/branchOf */ - public function event($event) + public function branchOf($branchOf) { - return $this->setProperty('event', $event); + return $this->setProperty('branchOf', $branchOf); } /** - * Upcoming or past events associated with this place or organization. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param Event|Event[] $events + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/events + * @see http://schema.org/brand */ - public function events($events) + public function brand($brand) { - return $this->setProperty('events', $events); + return $this->setProperty('brand', $brand); } /** - * The fax number. + * A contact point for a person or organization. * - * @param string|string[] $faxNumber + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/faxNumber + * @see http://schema.org/contactPoint */ - public function faxNumber($faxNumber) + public function contactPoint($contactPoint) { - return $this->setProperty('faxNumber', $faxNumber); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The geo coordinates of the place. + * A contact point for a person or organization. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/contactPoints */ - public function geo($geo) + public function contactPoints($contactPoints) { - return $this->setProperty('geo', $geo); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $globalLocationNumber + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/containedIn */ - public function globalLocationNumber($globalLocationNumber) + public function containedIn($containedIn) { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); + return $this->setProperty('containedIn', $containedIn); } /** - * A URL to a map of the place. + * The basic containment relation between a place and one that contains it. * - * @param Map|Map[]|string|string[] $hasMap + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/containedInPlace */ - public function hasMap($hasMap) + public function containedInPlace($containedInPlace) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The basic containment relation between a place and another that it + * contains. * - * @param bool|bool[] $isAccessibleForFree + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/containsPlace */ - public function isAccessibleForFree($isAccessibleForFree) + public function containsPlace($containsPlace) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $isicV4 + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/currenciesAccepted */ - public function isicV4($isicV4) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/department */ - public function latitude($latitude) + public function department($department) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('department', $department); } /** - * An associated logo. + * A description of the item. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param string|string[] $description * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/description */ - public function logo($logo) + public function description($description) { - return $this->setProperty('logo', $logo); + return $this->setProperty('description', $description); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * 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. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/disambiguatingDescription */ - public function longitude($longitude) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A URL to a map of the place. + * The date that this organization was dissolved. * - * @param string|string[] $map + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate * * @return static * - * @see http://schema.org/map + * @see http://schema.org/dissolutionDate */ - public function map($map) + public function dissolutionDate($dissolutionDate) { - return $this->setProperty('map', $map); + return $this->setProperty('dissolutionDate', $dissolutionDate); } /** - * A URL to a map of the place. + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. * - * @param string|string[] $maps + * @param string|string[] $duns * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/duns */ - public function maps($maps) + public function duns($duns) { - return $this->setProperty('maps', $maps); + return $this->setProperty('duns', $duns); } /** - * The total number of individuals that may attend an event or venue. + * Email address. * - * @param int|int[] $maximumAttendeeCapacity + * @param string|string[] $email * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/email */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function email($email) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('email', $email); } /** - * The opening hours of a certain place. + * Someone working for this organization. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Person|Person[] $employee * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/employee */ - public function openingHoursSpecification($openingHoursSpecification) + public function employee($employee) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('employee', $employee); } /** - * A photograph of this place. + * People working for this organization. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param Person|Person[] $employees * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/employees */ - public function photo($photo) + public function employees($employees) { - return $this->setProperty('photo', $photo); + return $this->setProperty('employees', $employees); } /** - * Photographs of this place. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/event */ - public function photos($photos) + public function event($event) { - return $this->setProperty('photos', $photos); + return $this->setProperty('event', $event); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * Upcoming or past events associated with this place or organization. * - * @param bool|bool[] $publicAccess + * @param Event|Event[] $events * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/events */ - public function publicAccess($publicAccess) + public function events($events) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('events', $events); } /** - * A review of the item. + * The fax number. * - * @param Review|Review[] $review + * @param string|string[] $faxNumber * * @return static * - * @see http://schema.org/review + * @see http://schema.org/faxNumber */ - public function review($review) + public function faxNumber($faxNumber) { - return $this->setProperty('review', $review); + return $this->setProperty('faxNumber', $faxNumber); } /** - * Review of the item. + * A person who founded this organization. * - * @param Review|Review[] $reviews + * @param Person|Person[] $founder * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/founder */ - public function reviews($reviews) + public function founder($founder) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('founder', $founder); } /** - * A slogan or motto associated with the item. + * A person who founded this organization. * - * @param string|string[] $slogan + * @param Person|Person[] $founders * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/founders */ - public function slogan($slogan) + public function founders($founders) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('founders', $founders); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * The date that this organization was founded. * - * @param bool|bool[] $smokingAllowed + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/foundingDate */ - public function smokingAllowed($smokingAllowed) + public function foundingDate($foundingDate) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('foundingDate', $foundingDate); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The place where the Organization was founded. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param Place|Place[] $foundingLocation * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/foundingLocation */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function foundingLocation($foundingLocation) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('foundingLocation', $foundingLocation); } /** - * The telephone number. + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $funder * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/funder */ - public function telephone($telephone) + public function funder($funder) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('funder', $funder); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geo coordinates of the place. * - * @param string|string[] $additionalType + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/geo */ - public function additionalType($additionalType) + public function geo($geo) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('geo', $geo); } /** - * An alias for the item. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $alternateName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/globalLocationNumber */ - public function alternateName($alternateName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * A description of the item. + * A URL to a map of the place. * - * @param string|string[] $description + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/description + * @see http://schema.org/hasMap */ - public function description($description) + public function hasMap($hasMap) { - return $this->setProperty('description', $description); + return $this->setProperty('hasMap', $hasMap); } /** - * 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. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param string|string[] $disambiguatingDescription + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/hasOfferCatalog */ - public function disambiguatingDescription($disambiguatingDescription) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); } /** @@ -624,657 +644,595 @@ public function image($image) } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A flag to signal that the item, event, or place is accessible for free. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/isAccessibleForFree */ - public function mainEntityOfPage($mainEntityOfPage) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The name of the item. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $name + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/name + * @see http://schema.org/isicV4 */ - public function name($name) + public function isicV4($isicV4) { - return $this->setProperty('name', $name); + return $this->setProperty('isicV4', $isicV4); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/latitude */ - public function potentialAction($potentialAction) + public function latitude($latitude) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('latitude', $latitude); } /** - * 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. + * The official name of the organization, e.g. the registered company name. * - * @param string|string[] $sameAs + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/legalName */ - public function sameAs($sameAs) + public function legalName($legalName) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('legalName', $legalName); } /** - * A CreativeWork or Event about this Thing. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/leiCode */ - public function subjectOf($subjectOf) + public function leiCode($leiCode) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $currenciesAccepted - * - * @return static - * - * @see http://schema.org/currenciesAccepted - */ - public function currenciesAccepted($currenciesAccepted) - { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); - } - - /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. - * - * @param string|string[] $paymentAccepted - * - * @return static - * - * @see http://schema.org/paymentAccepted - */ - public function paymentAccepted($paymentAccepted) - { - return $this->setProperty('paymentAccepted', $paymentAccepted); - } - - /** - * The price range of the business, for example ```$$$```. - * - * @param string|string[] $priceRange - * - * @return static - * - * @see http://schema.org/priceRange - */ - public function priceRange($priceRange) - { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('leiCode', $leiCode); } /** - * The geographic area where a service or offered item is provided. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/location */ - public function areaServed($areaServed) + public function location($location) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('location', $location); } /** - * An award won by or for this item. + * An associated logo. * - * @param string|string[] $award + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/award + * @see http://schema.org/logo */ - public function award($award) + public function logo($logo) { - return $this->setProperty('award', $award); + return $this->setProperty('logo', $logo); } /** - * Awards won by or for this item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $awards + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/longitude */ - public function awards($awards) + public function longitude($longitude) { - return $this->setProperty('awards', $awards); + return $this->setProperty('longitude', $longitude); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/mainEntityOfPage */ - public function brand($brand) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('brand', $brand); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A contact point for a person or organization. + * A pointer to products or services offered by the organization or person. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/makesOffer */ - public function contactPoint($contactPoint) + public function makesOffer($makesOffer) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A contact point for a person or organization. + * A URL to a map of the place. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $map * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/map */ - public function contactPoints($contactPoints) + public function map($map) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('map', $map); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * A URL to a map of the place. * - * @param Organization|Organization[] $department + * @param string|string[] $maps * * @return static * - * @see http://schema.org/department + * @see http://schema.org/maps */ - public function department($department) + public function maps($maps) { - return $this->setProperty('department', $department); + return $this->setProperty('maps', $maps); } /** - * The date that this organization was dissolved. + * The total number of individuals that may attend an event or venue. * - * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/dissolutionDate + * @see http://schema.org/maximumAttendeeCapacity */ - public function dissolutionDate($dissolutionDate) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('dissolutionDate', $dissolutionDate); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * The Dun & Bradstreet DUNS number for identifying an organization or - * business person. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param string|string[] $duns + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/duns + * @see http://schema.org/member */ - public function duns($duns) + public function member($member) { - return $this->setProperty('duns', $duns); + return $this->setProperty('member', $member); } /** - * Email address. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $email + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/email + * @see http://schema.org/memberOf */ - public function email($email) + public function memberOf($memberOf) { - return $this->setProperty('email', $email); + return $this->setProperty('memberOf', $memberOf); } /** - * Someone working for this organization. + * A member of this organization. * - * @param Person|Person[] $employee + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/employee + * @see http://schema.org/members */ - public function employee($employee) + public function members($members) { - return $this->setProperty('employee', $employee); + return $this->setProperty('members', $members); } /** - * People working for this organization. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param Person|Person[] $employees + * @param string|string[] $naics * * @return static * - * @see http://schema.org/employees + * @see http://schema.org/naics */ - public function employees($employees) + public function naics($naics) { - return $this->setProperty('employees', $employees); + return $this->setProperty('naics', $naics); } /** - * A person who founded this organization. + * The name of the item. * - * @param Person|Person[] $founder + * @param string|string[] $name * * @return static * - * @see http://schema.org/founder + * @see http://schema.org/name */ - public function founder($founder) + public function name($name) { - return $this->setProperty('founder', $founder); + return $this->setProperty('name', $name); } /** - * A person who founded this organization. + * The number of employees in an organization e.g. business. * - * @param Person|Person[] $founders + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/founders + * @see http://schema.org/numberOfEmployees */ - public function founders($founders) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('founders', $founders); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * The date that this organization was founded. + * A pointer to the organization or person making the offer. * - * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/foundingDate + * @see http://schema.org/offeredBy */ - public function foundingDate($foundingDate) + public function offeredBy($offeredBy) { - return $this->setProperty('foundingDate', $foundingDate); + return $this->setProperty('offeredBy', $offeredBy); } /** - * The place where the Organization was founded. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param Place|Place[] $foundingLocation + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/foundingLocation + * @see http://schema.org/openingHours */ - public function foundingLocation($foundingLocation) + public function openingHours($openingHours) { - return $this->setProperty('foundingLocation', $foundingLocation); + return $this->setProperty('openingHours', $openingHours); } /** - * A person or organization that supports (sponsors) something through some - * kind of financial contribution. + * The opening hours of a certain place. * - * @param Organization|Organization[]|Person|Person[] $funder + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/funder + * @see http://schema.org/openingHoursSpecification */ - public function funder($funder) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('funder', $funder); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * Products owned by the organization or person. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/owns */ - public function hasOfferCatalog($hasOfferCatalog) + public function owns($owns) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('owns', $owns); } /** - * Points-of-Sales operated by the organization or person. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param Place|Place[] $hasPOS + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/hasPOS + * @see http://schema.org/parentOrganization */ - public function hasPOS($hasPOS) + public function parentOrganization($parentOrganization) { - return $this->setProperty('hasPOS', $hasPOS); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The official name of the organization, e.g. the registered company name. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $legalName + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/paymentAccepted */ - public function legalName($legalName) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A photograph of this place. * - * @param string|string[] $leiCode + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/photo */ - public function leiCode($leiCode) + public function photo($photo) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('photo', $photo); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Photographs of this place. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/location + * @see http://schema.org/photos */ - public function location($location) + public function photos($photos) { - return $this->setProperty('location', $location); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services offered by the organization or person. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Offer|Offer[] $makesOffer + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/potentialAction */ - public function makesOffer($makesOffer) + public function potentialAction($potentialAction) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * The price range of the business, for example ```$$$```. * - * @param Organization|Organization[]|Person|Person[] $member + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/member + * @see http://schema.org/priceRange */ - public function member($member) + public function priceRange($priceRange) { - return $this->setProperty('member', $member); + return $this->setProperty('priceRange', $priceRange); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/publicAccess */ - public function memberOf($memberOf) + public function publicAccess($publicAccess) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A member of this organization. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $members + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/members + * @see http://schema.org/publishingPrinciples */ - public function members($members) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('members', $members); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * A review of the item. * - * @param string|string[] $naics + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/review */ - public function naics($naics) + public function review($review) { - return $this->setProperty('naics', $naics); + return $this->setProperty('review', $review); } /** - * The number of employees in an organization e.g. business. + * Review of the item. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/reviews */ - public function numberOfEmployees($numberOfEmployees) + public function reviews($reviews) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('reviews', $reviews); } /** - * A pointer to the organization or person making the offer. + * 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. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/sameAs */ - public function offeredBy($offeredBy) + public function sameAs($sameAs) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('sameAs', $sameAs); } /** - * Products owned by the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/seeks */ - public function owns($owns) + public function seeks($seeks) { - return $this->setProperty('owns', $owns); + return $this->setProperty('seeks', $seeks); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The geographic area where the service is provided. * - * @param Organization|Organization[] $parentOrganization + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/serviceArea */ - public function parentOrganization($parentOrganization) + public function serviceArea($serviceArea) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('serviceArea', $serviceArea); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/slogan */ - public function publishingPrinciples($publishingPrinciples) + public function slogan($slogan) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('slogan', $slogan); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param Demand|Demand[] $seeks + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/smokingAllowed */ - public function seeks($seeks) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * The geographic area where the service is provided. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/specialOpeningHoursSpecification */ - public function serviceArea($serviceArea) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** @@ -1309,6 +1267,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -1324,6 +1296,34 @@ public function taxID($taxID) return $this->setProperty('taxID', $taxID); } + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The Value-added Tax ID of the organization or person. * diff --git a/src/Flight.php b/src/Flight.php index b8415e5a8..096b1aee8 100644 --- a/src/Flight.php +++ b/src/Flight.php @@ -14,6 +14,25 @@ */ class Flight extends BaseType implements TripContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The kind of aircraft (e.g., "Boeing 747"). * @@ -28,6 +47,20 @@ public function aircraft($aircraft) return $this->setProperty('aircraft', $aircraft); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The airport where the flight terminates. * @@ -70,6 +103,20 @@ public function arrivalTerminal($arrivalTerminal) return $this->setProperty('arrivalTerminal', $arrivalTerminal); } + /** + * The expected arrival time. + * + * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime + * + * @return static + * + * @see http://schema.org/arrivalTime + */ + public function arrivalTime($arrivalTime) + { + return $this->setProperty('arrivalTime', $arrivalTime); + } + /** * The type of boarding policy used by the airline (e.g. zone-based or * group-based). @@ -142,107 +189,6 @@ public function departureTerminal($departureTerminal) return $this->setProperty('departureTerminal', $departureTerminal); } - /** - * The estimated time the flight will take. - * - * @param Duration|Duration[]|string|string[] $estimatedFlightDuration - * - * @return static - * - * @see http://schema.org/estimatedFlightDuration - */ - public function estimatedFlightDuration($estimatedFlightDuration) - { - return $this->setProperty('estimatedFlightDuration', $estimatedFlightDuration); - } - - /** - * The distance of the flight. - * - * @param Distance|Distance[]|string|string[] $flightDistance - * - * @return static - * - * @see http://schema.org/flightDistance - */ - public function flightDistance($flightDistance) - { - return $this->setProperty('flightDistance', $flightDistance); - } - - /** - * The unique identifier for a flight including the airline IATA code. For - * example, if describing United flight 110, where the IATA code for United - * is 'UA', the flightNumber is 'UA110'. - * - * @param string|string[] $flightNumber - * - * @return static - * - * @see http://schema.org/flightNumber - */ - public function flightNumber($flightNumber) - { - return $this->setProperty('flightNumber', $flightNumber); - } - - /** - * Description of the meals that will be provided or available for purchase. - * - * @param string|string[] $mealService - * - * @return static - * - * @see http://schema.org/mealService - */ - public function mealService($mealService) - { - return $this->setProperty('mealService', $mealService); - } - - /** - * An entity which offers (sells / leases / lends / loans) the services / - * goods. A seller may also be a provider. - * - * @param Organization|Organization[]|Person|Person[] $seller - * - * @return static - * - * @see http://schema.org/seller - */ - public function seller($seller) - { - return $this->setProperty('seller', $seller); - } - - /** - * The time when a passenger can check into the flight online. - * - * @param \DateTimeInterface|\DateTimeInterface[] $webCheckinTime - * - * @return static - * - * @see http://schema.org/webCheckinTime - */ - public function webCheckinTime($webCheckinTime) - { - return $this->setProperty('webCheckinTime', $webCheckinTime); - } - - /** - * The expected arrival time. - * - * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime - * - * @return static - * - * @see http://schema.org/arrivalTime - */ - public function arrivalTime($arrivalTime) - { - return $this->setProperty('arrivalTime', $arrivalTime); - } - /** * The expected departure time. * @@ -258,99 +204,78 @@ public function departureTime($departureTime) } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. - * - * @param Offer|Offer[] $offers - * - * @return static - * - * @see http://schema.org/offers - */ - public function offers($offers) - { - return $this->setProperty('offers', $offers); - } - - /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param string|string[] $description * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/description */ - public function provider($provider) + public function description($description) { - return $this->setProperty('provider', $provider); + return $this->setProperty('description', $description); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * 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. * - * @param string|string[] $additionalType + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/disambiguatingDescription */ - public function additionalType($additionalType) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * An alias for the item. + * The estimated time the flight will take. * - * @param string|string[] $alternateName + * @param Duration|Duration[]|string|string[] $estimatedFlightDuration * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/estimatedFlightDuration */ - public function alternateName($alternateName) + public function estimatedFlightDuration($estimatedFlightDuration) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('estimatedFlightDuration', $estimatedFlightDuration); } /** - * A description of the item. + * The distance of the flight. * - * @param string|string[] $description + * @param Distance|Distance[]|string|string[] $flightDistance * * @return static * - * @see http://schema.org/description + * @see http://schema.org/flightDistance */ - public function description($description) + public function flightDistance($flightDistance) { - return $this->setProperty('description', $description); + return $this->setProperty('flightDistance', $flightDistance); } /** - * 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. + * The unique identifier for a flight including the airline IATA code. For + * example, if describing United flight 110, where the IATA code for United + * is 'UA', the flightNumber is 'UA110'. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $flightNumber * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/flightNumber */ - public function disambiguatingDescription($disambiguatingDescription) + public function flightNumber($flightNumber) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('flightNumber', $flightNumber); } /** @@ -402,6 +327,20 @@ public function mainEntityOfPage($mainEntityOfPage) return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } + /** + * Description of the meals that will be provided or available for purchase. + * + * @param string|string[] $mealService + * + * @return static + * + * @see http://schema.org/mealService + */ + public function mealService($mealService) + { + return $this->setProperty('mealService', $mealService); + } + /** * The name of the item. * @@ -416,6 +355,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -431,6 +386,22 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + /** * 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 @@ -447,6 +418,21 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * An entity which offers (sells / leases / lends / loans) the services / + * goods. A seller may also be a provider. + * + * @param Organization|Organization[]|Person|Person[] $seller + * + * @return static + * + * @see http://schema.org/seller + */ + public function seller($seller) + { + return $this->setProperty('seller', $seller); + } + /** * A CreativeWork or Event about this Thing. * @@ -475,4 +461,18 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The time when a passenger can check into the flight online. + * + * @param \DateTimeInterface|\DateTimeInterface[] $webCheckinTime + * + * @return static + * + * @see http://schema.org/webCheckinTime + */ + public function webCheckinTime($webCheckinTime) + { + return $this->setProperty('webCheckinTime', $webCheckinTime); + } + } diff --git a/src/FlightReservation.php b/src/FlightReservation.php index 6a49bea5f..a579b15dd 100644 --- a/src/FlightReservation.php +++ b/src/FlightReservation.php @@ -19,46 +19,36 @@ class FlightReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** - * The priority status assigned to a passenger for security or boarding - * (e.g. FastTrack or Priority). - * - * @param QualitativeValue|QualitativeValue[]|string|string[] $passengerPriorityStatus - * - * @return static - * - * @see http://schema.org/passengerPriorityStatus - */ - public function passengerPriorityStatus($passengerPriorityStatus) - { - return $this->setProperty('passengerPriorityStatus', $passengerPriorityStatus); - } - - /** - * The passenger's sequence number as assigned by the airline. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $passengerSequenceNumber + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/passengerSequenceNumber + * @see http://schema.org/additionalType */ - public function passengerSequenceNumber($passengerSequenceNumber) + public function additionalType($additionalType) { - return $this->setProperty('passengerSequenceNumber', $passengerSequenceNumber); + return $this->setProperty('additionalType', $additionalType); } /** - * The type of security screening the passenger is subject to. + * An alias for the item. * - * @param string|string[] $securityScreening + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/securityScreening + * @see http://schema.org/alternateName */ - public function securityScreening($securityScreening) + public function alternateName($alternateName) { - return $this->setProperty('securityScreening', $securityScreening); + return $this->setProperty('alternateName', $alternateName); } /** @@ -108,335 +98,345 @@ public function broker($broker) } /** - * The date and time the reservation was modified. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/description */ - public function modifiedTime($modifiedTime) + public function description($description) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('description', $description); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. * - * @param string|string[] $priceCurrency + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/disambiguatingDescription */ - public function priceCurrency($priceCurrency) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/identifier */ - public function programMembershipUsed($programMembershipUsed) + public function identifier($identifier) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('identifier', $identifier); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/image */ - public function provider($provider) + public function image($image) { - return $this->setProperty('provider', $provider); + return $this->setProperty('image', $image); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $reservationFor + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/mainEntityOfPage */ - public function reservationFor($reservationFor) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A unique identifier for the reservation. + * The date and time the reservation was modified. * - * @param string|string[] $reservationId + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/modifiedTime */ - public function reservationId($reservationId) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The current status of the reservation. + * The name of the item. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/name */ - public function reservationStatus($reservationStatus) + public function name($name) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('name', $name); } /** - * A ticket associated with the reservation. + * The priority status assigned to a passenger for security or boarding + * (e.g. FastTrack or Priority). * - * @param Ticket|Ticket[] $reservedTicket + * @param QualitativeValue|QualitativeValue[]|string|string[] $passengerPriorityStatus * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/passengerPriorityStatus */ - public function reservedTicket($reservedTicket) + public function passengerPriorityStatus($passengerPriorityStatus) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('passengerPriorityStatus', $passengerPriorityStatus); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. + * The passenger's sequence number as assigned by the airline. * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * @param string|string[] $passengerSequenceNumber * * @return static * - * @see http://schema.org/totalPrice + * @see http://schema.org/passengerSequenceNumber */ - public function totalPrice($totalPrice) + public function passengerSequenceNumber($passengerSequenceNumber) { - return $this->setProperty('totalPrice', $totalPrice); + return $this->setProperty('passengerSequenceNumber', $passengerSequenceNumber); } /** - * The person or organization the reservation or ticket is for. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Organization|Organization[]|Person|Person[] $underName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/underName + * @see http://schema.org/potentialAction */ - public function underName($underName) + public function potentialAction($potentialAction) { - return $this->setProperty('underName', $underName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $additionalType + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/priceCurrency */ - public function additionalType($additionalType) + public function priceCurrency($priceCurrency) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An alias for the item. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $alternateName + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/programMembershipUsed */ - public function alternateName($alternateName) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * A description of the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/description + * @see http://schema.org/provider */ - public function description($description) + public function provider($provider) { - return $this->setProperty('description', $description); + return $this->setProperty('provider', $provider); } /** - * 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. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/reservationFor */ - public function disambiguatingDescription($disambiguatingDescription) + public function reservationFor($reservationFor) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('reservationFor', $reservationFor); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A unique identifier for the reservation. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reservationId */ - public function identifier($identifier) + public function reservationId($reservationId) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reservationId', $reservationId); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The current status of the reservation. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservationStatus */ - public function image($image) + public function reservationStatus($reservationStatus) { - return $this->setProperty('image', $image); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A ticket associated with the reservation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/reservedTicket */ - public function mainEntityOfPage($mainEntityOfPage) + public function reservedTicket($reservedTicket) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('reservedTicket', $reservedTicket); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of security screening the passenger is subject to. * - * @param Action|Action[] $potentialAction + * @param string|string[] $securityScreening * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/securityScreening */ - public function potentialAction($potentialAction) + public function securityScreening($securityScreening) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('securityScreening', $securityScreening); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/totalPrice */ - public function subjectOf($subjectOf) + public function totalPrice($totalPrice) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); } /** diff --git a/src/Florist.php b/src/Florist.php index d3ea81a5b..881f33b69 100644 --- a/src/Florist.php +++ b/src/Florist.php @@ -17,126 +17,104 @@ class Florist extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/FollowAction.php b/src/FollowAction.php index 4d4960ade..6eb2e4d5b 100644 --- a/src/FollowAction.php +++ b/src/FollowAction.php @@ -30,31 +30,36 @@ class FollowAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { /** - * A sub property of object. The person or organization being followed. + * Indicates the current disposition of the Action. * - * @param Organization|Organization[]|Person|Person[] $followee + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/followee + * @see http://schema.org/actionStatus */ - public function followee($followee) + public function actionStatus($actionStatus) { - return $this->setProperty('followee', $followee); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -73,325 +78,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * A sub property of object. The person or organization being followed. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Organization|Organization[]|Person|Person[] $followee * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/followee */ - public function participant($participant) + public function followee($followee) { - return $this->setProperty('participant', $participant); + return $this->setProperty('followee', $followee); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/FoodEstablishment.php b/src/FoodEstablishment.php index aa105203f..4a38660c9 100644 --- a/src/FoodEstablishment.php +++ b/src/FoodEstablishment.php @@ -32,289 +32,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -503,914 +551,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/FoodEstablishmentReservation.php b/src/FoodEstablishmentReservation.php index c4f0a2c5b..70c164673 100644 --- a/src/FoodEstablishmentReservation.php +++ b/src/FoodEstablishmentReservation.php @@ -19,63 +19,36 @@ class FoodEstablishmentReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime - * - * @return static - * - * @see http://schema.org/endTime - */ - public function endTime($endTime) - { - return $this->setProperty('endTime', $endTime); - } - - /** - * Number of people the reservation should accommodate. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|int|int[] $partySize + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/partySize + * @see http://schema.org/additionalType */ - public function partySize($partySize) + public function additionalType($additionalType) { - return $this->setProperty('partySize', $partySize); + return $this->setProperty('additionalType', $additionalType); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/alternateName */ - public function startTime($startTime) + public function alternateName($alternateName) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('alternateName', $alternateName); } /** @@ -125,335 +98,362 @@ public function broker($broker) } /** - * The date and time the reservation was modified. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/description */ - public function modifiedTime($modifiedTime) + public function description($description) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('description', $description); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $priceCurrency + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/endTime */ - public function priceCurrency($priceCurrency) + public function endTime($endTime) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('endTime', $endTime); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/identifier */ - public function programMembershipUsed($programMembershipUsed) + public function identifier($identifier) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('identifier', $identifier); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/image */ - public function provider($provider) + public function image($image) { - return $this->setProperty('provider', $provider); + return $this->setProperty('image', $image); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $reservationFor + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/mainEntityOfPage */ - public function reservationFor($reservationFor) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A unique identifier for the reservation. + * The date and time the reservation was modified. * - * @param string|string[] $reservationId + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/modifiedTime */ - public function reservationId($reservationId) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The current status of the reservation. + * The name of the item. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/name */ - public function reservationStatus($reservationStatus) + public function name($name) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('name', $name); } /** - * A ticket associated with the reservation. + * Number of people the reservation should accommodate. * - * @param Ticket|Ticket[] $reservedTicket + * @param QuantitativeValue|QuantitativeValue[]|int|int[] $partySize * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/partySize */ - public function reservedTicket($reservedTicket) + public function partySize($partySize) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('partySize', $partySize); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/totalPrice + * @see http://schema.org/potentialAction */ - public function totalPrice($totalPrice) + public function potentialAction($potentialAction) { - return $this->setProperty('totalPrice', $totalPrice); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The person or organization the reservation or ticket is for. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Organization|Organization[]|Person|Person[] $underName + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/underName + * @see http://schema.org/priceCurrency */ - public function underName($underName) + public function priceCurrency($priceCurrency) { - return $this->setProperty('underName', $underName); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $additionalType + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/programMembershipUsed */ - public function additionalType($additionalType) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param string|string[] $description + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/description + * @see http://schema.org/reservationFor */ - public function description($description) + public function reservationFor($reservationFor) { - return $this->setProperty('description', $description); + return $this->setProperty('reservationFor', $reservationFor); } /** - * 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. + * A unique identifier for the reservation. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/reservationId */ - public function disambiguatingDescription($disambiguatingDescription) + public function reservationId($reservationId) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('reservationId', $reservationId); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The current status of the reservation. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reservationStatus */ - public function identifier($identifier) + public function reservationStatus($reservationStatus) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A ticket associated with the reservation. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservedTicket */ - public function image($image) + public function reservedTicket($reservedTicket) { - return $this->setProperty('image', $image); + return $this->setProperty('reservedTicket', $reservedTicket); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param string|string[] $sameAs + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/totalPrice */ - public function sameAs($sameAs) + public function totalPrice($totalPrice) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('totalPrice', $totalPrice); } /** - * A CreativeWork or Event about this Thing. + * The person or organization the reservation or ticket is for. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Organization|Organization[]|Person|Person[] $underName * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/underName */ - public function subjectOf($subjectOf) + public function underName($underName) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('underName', $underName); } /** diff --git a/src/FoodEvent.php b/src/FoodEvent.php index 7656985d0..b0ac35004 100644 --- a/src/FoodEvent.php +++ b/src/FoodEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/FoodService.php b/src/FoodService.php index fb896806b..21c709d1e 100644 --- a/src/FoodService.php +++ b/src/FoodService.php @@ -14,6 +14,25 @@ */ class FoodService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -29,6 +48,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -133,6 +166,37 @@ public function category($category) return $this->setProperty('category', $category); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -162,6 +226,39 @@ public function hoursAvailable($hoursAvailable) return $this->setProperty('hoursAvailable', $hoursAvailable); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another, somehow related product (or multiple products). * @@ -205,6 +302,36 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -221,6 +348,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The tangible thing generated by the service, e.g. a passport, permit, * etc. @@ -280,6 +422,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The geographic area where the service is provided. * @@ -352,164 +510,6 @@ public function slogan($slogan) return $this->setProperty('slogan', $slogan); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - /** * A CreativeWork or Event about this Thing. * diff --git a/src/FurnitureStore.php b/src/FurnitureStore.php index 228f95966..6bda683c3 100644 --- a/src/FurnitureStore.php +++ b/src/FurnitureStore.php @@ -17,126 +17,104 @@ class FurnitureStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Game.php b/src/Game.php index d3e8d6778..fd1a3b9df 100644 --- a/src/Game.php +++ b/src/Game.php @@ -15,79 +15,6 @@ */ class Game extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A piece of data that represents a particular aspect of a fictional - * character (skill, power, character points, advantage, disadvantage). - * - * @param Thing|Thing[] $characterAttribute - * - * @return static - * - * @see http://schema.org/characterAttribute - */ - public function characterAttribute($characterAttribute) - { - return $this->setProperty('characterAttribute', $characterAttribute); - } - - /** - * An item is an object within the game world that can be collected by a - * player or, occasionally, a non-player character. - * - * @param Thing|Thing[] $gameItem - * - * @return static - * - * @see http://schema.org/gameItem - */ - public function gameItem($gameItem) - { - return $this->setProperty('gameItem', $gameItem); - } - - /** - * Real or fictional location of the game (or part of game). - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $gameLocation - * - * @return static - * - * @see http://schema.org/gameLocation - */ - public function gameLocation($gameLocation) - { - return $this->setProperty('gameLocation', $gameLocation); - } - - /** - * Indicate how many people can play this game (minimum, maximum, or range). - * - * @param QuantitativeValue|QuantitativeValue[] $numberOfPlayers - * - * @return static - * - * @see http://schema.org/numberOfPlayers - */ - public function numberOfPlayers($numberOfPlayers) - { - return $this->setProperty('numberOfPlayers', $numberOfPlayers); - } - - /** - * The task that a player-controlled character, or group of characters may - * complete in order to gain a reward. - * - * @param Thing|Thing[] $quest - * - * @return static - * - * @see http://schema.org/quest - */ - public function quest($quest) - { - return $this->setProperty('quest', $quest); - } - /** * The subject matter of the content. * @@ -232,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -247,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -362,6 +322,21 @@ public function character($character) return $this->setProperty('character', $character); } + /** + * A piece of data that represents a particular aspect of a fictional + * character (skill, power, character points, advantage, disadvantage). + * + * @param Thing|Thing[] $characterAttribute + * + * @return static + * + * @see http://schema.org/characterAttribute + */ + public function characterAttribute($characterAttribute) + { + return $this->setProperty('characterAttribute', $characterAttribute); + } + /** * A citation or reference to another creative work, such as another * publication, web page, scholarly article, etc. @@ -538,6 +513,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -720,6 +726,35 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * An item is an object within the game world that can be collected by a + * player or, occasionally, a non-player character. + * + * @param Thing|Thing[] $gameItem + * + * @return static + * + * @see http://schema.org/gameItem + */ + public function gameItem($gameItem) + { + return $this->setProperty('gameItem', $gameItem); + } + + /** + * Real or fictional location of the game (or part of game). + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $gameLocation + * + * @return static + * + * @see http://schema.org/gameLocation + */ + public function gameLocation($gameLocation) + { + return $this->setProperty('gameLocation', $gameLocation); + } + /** * Genre of the creative work, broadcast channel or group. * @@ -763,6 +798,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -960,6 +1028,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -991,40 +1075,83 @@ public function mentions($mentions) } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * The name of the item. * - * @param Offer|Offer[] $offers + * @param string|string[] $name * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/name */ - public function offers($offers) + public function name($name) { - return $this->setProperty('offers', $offers); + return $this->setProperty('name', $name); } /** - * The position of an item in a series or sequence of items. + * Indicate how many people can play this game (minimum, maximum, or range). * - * @param int|int[]|string|string[] $position + * @param QuantitativeValue|QuantitativeValue[] $numberOfPlayers * * @return static * - * @see http://schema.org/position + * @see http://schema.org/numberOfPlayers */ - public function position($position) + public function numberOfPlayers($numberOfPlayers) { - return $this->setProperty('position', $position); + return $this->setProperty('numberOfPlayers', $numberOfPlayers); } /** - * The person or organization who produced the work (e.g. music album, - * movie, tv/radio series etc.). - * - * @param Organization|Organization[]|Person|Person[] $producer + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). + * + * @param Organization|Organization[]|Person|Person[] $producer * * @return static * @@ -1103,6 +1230,21 @@ public function publishingPrinciples($publishingPrinciples) return $this->setProperty('publishingPrinciples', $publishingPrinciples); } + /** + * The task that a player-controlled character, or group of characters may + * complete in order to gain a reward. + * + * @param Thing|Thing[] $quest + * + * @return static + * + * @see http://schema.org/quest + */ + public function quest($quest) + { + return $this->setProperty('quest', $quest); + } + /** * The Event where the CreativeWork was recorded. The CreativeWork may * capture all or part of the event. @@ -1161,6 +1303,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1243,6 +1401,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1364,6 +1536,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1407,190 +1593,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/GameServer.php b/src/GameServer.php index 557048593..589c2f934 100644 --- a/src/GameServer.php +++ b/src/GameServer.php @@ -13,48 +13,6 @@ */ class GameServer extends BaseType implements IntangibleContract, ThingContract { - /** - * Video game which is played on this server. - * - * @param VideoGame|VideoGame[] $game - * - * @return static - * - * @see http://schema.org/game - */ - public function game($game) - { - return $this->setProperty('game', $game); - } - - /** - * Number of players on the server. - * - * @param int|int[] $playersOnline - * - * @return static - * - * @see http://schema.org/playersOnline - */ - public function playersOnline($playersOnline) - { - return $this->setProperty('playersOnline', $playersOnline); - } - - /** - * Status of a game server. - * - * @param GameServerStatus|GameServerStatus[] $serverStatus - * - * @return static - * - * @see http://schema.org/serverStatus - */ - public function serverStatus($serverStatus) - { - return $this->setProperty('serverStatus', $serverStatus); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -119,6 +77,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * Video game which is played on this server. + * + * @param VideoGame|VideoGame[] $game + * + * @return static + * + * @see http://schema.org/game + */ + public function game($game) + { + return $this->setProperty('game', $game); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -182,6 +154,20 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * Number of players on the server. + * + * @param int|int[] $playersOnline + * + * @return static + * + * @see http://schema.org/playersOnline + */ + public function playersOnline($playersOnline) + { + return $this->setProperty('playersOnline', $playersOnline); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -213,6 +199,20 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * Status of a game server. + * + * @param GameServerStatus|GameServerStatus[] $serverStatus + * + * @return static + * + * @see http://schema.org/serverStatus + */ + public function serverStatus($serverStatus) + { + return $this->setProperty('serverStatus', $serverStatus); + } + /** * A CreativeWork or Event about this Thing. * diff --git a/src/GardenStore.php b/src/GardenStore.php index 66f44a2c2..2816b2959 100644 --- a/src/GardenStore.php +++ b/src/GardenStore.php @@ -17,126 +17,104 @@ class GardenStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/GasStation.php b/src/GasStation.php index bd146f127..1acd87843 100644 --- a/src/GasStation.php +++ b/src/GasStation.php @@ -17,126 +17,104 @@ class GasStation extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/GatedResidenceCommunity.php b/src/GatedResidenceCommunity.php index e3a64795b..c3b7b062b 100644 --- a/src/GatedResidenceCommunity.php +++ b/src/GatedResidenceCommunity.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/GeneralContractor.php b/src/GeneralContractor.php index 1212d36ef..f613276f7 100644 --- a/src/GeneralContractor.php +++ b/src/GeneralContractor.php @@ -17,126 +17,104 @@ class GeneralContractor extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/GeoCircle.php b/src/GeoCircle.php index ffb47d010..6c18ee5c1 100644 --- a/src/GeoCircle.php +++ b/src/GeoCircle.php @@ -21,18 +21,22 @@ class GeoCircle extends BaseType implements GeoShapeContract, StructuredValueContract, IntangibleContract, ThingContract { /** - * Indicates the approximate radius of a GeoCircle (metres unless indicated - * otherwise via Distance notation). + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Distance|Distance[]|float|float[]|int|int[]|string|string[] $geoRadius + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/geoRadius + * @see http://schema.org/additionalType */ - public function geoRadius($geoRadius) + public function additionalType($additionalType) { - return $this->setProperty('geoRadius', $geoRadius); + return $this->setProperty('additionalType', $additionalType); } /** @@ -64,6 +68,20 @@ public function addressCountry($addressCountry) return $this->setProperty('addressCountry', $addressCountry); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A box is the area enclosed by the rectangle formed by two points. The * first point is the lower corner, the second point is the upper corner. A @@ -97,144 +115,80 @@ public function circle($circle) } /** - * The elevation of a location ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be - * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') - * while numbers alone should be assumed to be a value in meters. - * - * @param float|float[]|int|int[]|string|string[] $elevation - * - * @return static - * - * @see http://schema.org/elevation - */ - public function elevation($elevation) - { - return $this->setProperty('elevation', $elevation); - } - - /** - * Indicates the GeoCoordinates at the centre of a GeoShape e.g. GeoCircle. - * - * @param GeoCoordinates|GeoCoordinates[] $geoMidpoint - * - * @return static - * - * @see http://schema.org/geoMidpoint - */ - public function geoMidpoint($geoMidpoint) - { - return $this->setProperty('geoMidpoint', $geoMidpoint); - } - - /** - * A line is a point-to-point path consisting of two or more points. A line - * is expressed as a series of two or more point objects separated by space. - * - * @param string|string[] $line - * - * @return static - * - * @see http://schema.org/line - */ - public function line($line) - { - return $this->setProperty('line', $line); - } - - /** - * A polygon is the area enclosed by a point-to-point path for which the - * starting and ending points are the same. A polygon is expressed as a - * series of four or more space delimited points where the first and final - * points are identical. - * - * @param string|string[] $polygon - * - * @return static - * - * @see http://schema.org/polygon - */ - public function polygon($polygon) - { - return $this->setProperty('polygon', $polygon); - } - - /** - * The postal code. For example, 94043. + * A description of the item. * - * @param string|string[] $postalCode + * @param string|string[] $description * * @return static * - * @see http://schema.org/postalCode + * @see http://schema.org/description */ - public function postalCode($postalCode) + public function description($description) { - return $this->setProperty('postalCode', $postalCode); + return $this->setProperty('description', $description); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * 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. * - * @param string|string[] $additionalType + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/disambiguatingDescription */ - public function additionalType($additionalType) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * An alias for the item. + * The elevation of a location ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be + * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') + * while numbers alone should be assumed to be a value in meters. * - * @param string|string[] $alternateName + * @param float|float[]|int|int[]|string|string[] $elevation * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/elevation */ - public function alternateName($alternateName) + public function elevation($elevation) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('elevation', $elevation); } /** - * A description of the item. + * Indicates the GeoCoordinates at the centre of a GeoShape e.g. GeoCircle. * - * @param string|string[] $description + * @param GeoCoordinates|GeoCoordinates[] $geoMidpoint * * @return static * - * @see http://schema.org/description + * @see http://schema.org/geoMidpoint */ - public function description($description) + public function geoMidpoint($geoMidpoint) { - return $this->setProperty('description', $description); + return $this->setProperty('geoMidpoint', $geoMidpoint); } /** - * 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. + * Indicates the approximate radius of a GeoCircle (metres unless indicated + * otherwise via Distance notation). * - * @param string|string[] $disambiguatingDescription + * @param Distance|Distance[]|float|float[]|int|int[]|string|string[] $geoRadius * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/geoRadius */ - public function disambiguatingDescription($disambiguatingDescription) + public function geoRadius($geoRadius) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('geoRadius', $geoRadius); } /** @@ -270,6 +224,21 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * A line is a point-to-point path consisting of two or more points. A line + * is expressed as a series of two or more point objects separated by space. + * + * @param string|string[] $line + * + * @return static + * + * @see http://schema.org/line + */ + public function line($line) + { + return $this->setProperty('line', $line); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -300,6 +269,37 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A polygon is the area enclosed by a point-to-point path for which the + * starting and ending points are the same. A polygon is expressed as a + * series of four or more space delimited points where the first and final + * points are identical. + * + * @param string|string[] $polygon + * + * @return static + * + * @see http://schema.org/polygon + */ + public function polygon($polygon) + { + return $this->setProperty('polygon', $polygon); + } + + /** + * The postal code. For example, 94043. + * + * @param string|string[] $postalCode + * + * @return static + * + * @see http://schema.org/postalCode + */ + public function postalCode($postalCode) + { + return $this->setProperty('postalCode', $postalCode); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/GeoCoordinates.php b/src/GeoCoordinates.php index 2c44b658f..cd668e1ee 100644 --- a/src/GeoCoordinates.php +++ b/src/GeoCoordinates.php @@ -14,6 +14,25 @@ */ class GeoCoordinates extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -43,86 +62,6 @@ public function addressCountry($addressCountry) return $this->setProperty('addressCountry', $addressCountry); } - /** - * The elevation of a location ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be - * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') - * while numbers alone should be assumed to be a value in meters. - * - * @param float|float[]|int|int[]|string|string[] $elevation - * - * @return static - * - * @see http://schema.org/elevation - */ - public function elevation($elevation) - { - return $this->setProperty('elevation', $elevation); - } - - /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $latitude - * - * @return static - * - * @see http://schema.org/latitude - */ - public function latitude($latitude) - { - return $this->setProperty('latitude', $latitude); - } - - /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $longitude - * - * @return static - * - * @see http://schema.org/longitude - */ - public function longitude($longitude) - { - return $this->setProperty('longitude', $longitude); - } - - /** - * The postal code. For example, 94043. - * - * @param string|string[] $postalCode - * - * @return static - * - * @see http://schema.org/postalCode - */ - public function postalCode($postalCode) - { - return $this->setProperty('postalCode', $postalCode); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - /** * An alias for the item. * @@ -168,6 +107,23 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The elevation of a location ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be + * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') + * while numbers alone should be assumed to be a value in meters. + * + * @param float|float[]|int|int[]|string|string[] $elevation + * + * @return static + * + * @see http://schema.org/elevation + */ + public function elevation($elevation) + { + return $this->setProperty('elevation', $elevation); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -201,6 +157,36 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -231,6 +217,20 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The postal code. For example, 94043. + * + * @param string|string[] $postalCode + * + * @return static + * + * @see http://schema.org/postalCode + */ + public function postalCode($postalCode) + { + return $this->setProperty('postalCode', $postalCode); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/GeoShape.php b/src/GeoShape.php index ec0b97df2..b77ab7cf7 100644 --- a/src/GeoShape.php +++ b/src/GeoShape.php @@ -17,6 +17,25 @@ */ class GeoShape extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -46,6 +65,20 @@ public function addressCountry($addressCountry) return $this->setProperty('addressCountry', $addressCountry); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A box is the area enclosed by the rectangle formed by two points. The * first point is the lower corner, the second point is the upper corner. A @@ -79,144 +112,65 @@ public function circle($circle) } /** - * The elevation of a location ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be - * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') - * while numbers alone should be assumed to be a value in meters. - * - * @param float|float[]|int|int[]|string|string[] $elevation - * - * @return static - * - * @see http://schema.org/elevation - */ - public function elevation($elevation) - { - return $this->setProperty('elevation', $elevation); - } - - /** - * Indicates the GeoCoordinates at the centre of a GeoShape e.g. GeoCircle. - * - * @param GeoCoordinates|GeoCoordinates[] $geoMidpoint - * - * @return static - * - * @see http://schema.org/geoMidpoint - */ - public function geoMidpoint($geoMidpoint) - { - return $this->setProperty('geoMidpoint', $geoMidpoint); - } - - /** - * A line is a point-to-point path consisting of two or more points. A line - * is expressed as a series of two or more point objects separated by space. - * - * @param string|string[] $line - * - * @return static - * - * @see http://schema.org/line - */ - public function line($line) - { - return $this->setProperty('line', $line); - } - - /** - * A polygon is the area enclosed by a point-to-point path for which the - * starting and ending points are the same. A polygon is expressed as a - * series of four or more space delimited points where the first and final - * points are identical. - * - * @param string|string[] $polygon - * - * @return static - * - * @see http://schema.org/polygon - */ - public function polygon($polygon) - { - return $this->setProperty('polygon', $polygon); - } - - /** - * The postal code. For example, 94043. - * - * @param string|string[] $postalCode - * - * @return static - * - * @see http://schema.org/postalCode - */ - public function postalCode($postalCode) - { - return $this->setProperty('postalCode', $postalCode); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * A description of the item. * - * @param string|string[] $additionalType + * @param string|string[] $description * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/description */ - public function additionalType($additionalType) + public function description($description) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('description', $description); } /** - * An alias for the item. + * 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. * - * @param string|string[] $alternateName + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/disambiguatingDescription */ - public function alternateName($alternateName) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A description of the item. + * The elevation of a location ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be + * of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') + * while numbers alone should be assumed to be a value in meters. * - * @param string|string[] $description + * @param float|float[]|int|int[]|string|string[] $elevation * * @return static * - * @see http://schema.org/description + * @see http://schema.org/elevation */ - public function description($description) + public function elevation($elevation) { - return $this->setProperty('description', $description); + return $this->setProperty('elevation', $elevation); } /** - * 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. + * Indicates the GeoCoordinates at the centre of a GeoShape e.g. GeoCircle. * - * @param string|string[] $disambiguatingDescription + * @param GeoCoordinates|GeoCoordinates[] $geoMidpoint * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/geoMidpoint */ - public function disambiguatingDescription($disambiguatingDescription) + public function geoMidpoint($geoMidpoint) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('geoMidpoint', $geoMidpoint); } /** @@ -252,6 +206,21 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * A line is a point-to-point path consisting of two or more points. A line + * is expressed as a series of two or more point objects separated by space. + * + * @param string|string[] $line + * + * @return static + * + * @see http://schema.org/line + */ + public function line($line) + { + return $this->setProperty('line', $line); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -282,6 +251,37 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A polygon is the area enclosed by a point-to-point path for which the + * starting and ending points are the same. A polygon is expressed as a + * series of four or more space delimited points where the first and final + * points are identical. + * + * @param string|string[] $polygon + * + * @return static + * + * @see http://schema.org/polygon + */ + public function polygon($polygon) + { + return $this->setProperty('polygon', $polygon); + } + + /** + * The postal code. For example, 94043. + * + * @param string|string[] $postalCode + * + * @return static + * + * @see http://schema.org/postalCode + */ + public function postalCode($postalCode) + { + return $this->setProperty('postalCode', $postalCode); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/GiveAction.php b/src/GiveAction.php index 1f40ac9ff..b00deec7e 100644 --- a/src/GiveAction.php +++ b/src/GiveAction.php @@ -23,77 +23,96 @@ class GiveAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * Indicates the current disposition of the Action. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/actionStatus */ - public function recipient($recipient) + public function actionStatus($actionStatus) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The original location of the object or the - * agent before the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $fromLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/additionalType */ - public function fromLocation($fromLocation) + public function additionalType($additionalType) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Place|Place[] $toLocation + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/agent */ - public function toLocation($toLocation) + public function agent($agent) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -134,288 +153,269 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/location + * @see http://schema.org/fromLocation */ - public function location($location) + public function fromLocation($fromLocation) { - return $this->setProperty('location', $location); + return $this->setProperty('fromLocation', $fromLocation); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $object + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/object + * @see http://schema.org/identifier */ - public function object($object) + public function identifier($identifier) { - return $this->setProperty('object', $object); + return $this->setProperty('identifier', $identifier); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/image */ - public function participant($participant) + public function image($image) { - return $this->setProperty('participant', $participant); + return $this->setProperty('image', $image); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/recipient */ - public function identifier($identifier) + public function recipient($recipient) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('recipient', $recipient); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/GolfCourse.php b/src/GolfCourse.php index 8281a5447..2d60604ec 100644 --- a/src/GolfCourse.php +++ b/src/GolfCourse.php @@ -17,126 +17,104 @@ class GolfCourse extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/GovernmentBuilding.php b/src/GovernmentBuilding.php index 49220b2c8..e6d0158f4 100644 --- a/src/GovernmentBuilding.php +++ b/src/GovernmentBuilding.php @@ -14,35 +14,6 @@ */ class GovernmentBuilding extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/GovernmentOffice.php b/src/GovernmentOffice.php index 90a73c26a..2f13b45f0 100644 --- a/src/GovernmentOffice.php +++ b/src/GovernmentOffice.php @@ -16,126 +16,104 @@ class GovernmentOffice extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/GovernmentOrganization.php b/src/GovernmentOrganization.php index 3e6efe3db..1a1e64b40 100644 --- a/src/GovernmentOrganization.php +++ b/src/GovernmentOrganization.php @@ -13,6 +13,25 @@ */ class GovernmentOrganization extends BaseType implements OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -42,6 +61,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -144,6 +177,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -375,6 +439,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -449,6 +546,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -522,6 +635,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -579,6 +706,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -631,6 +773,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -706,6 +864,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -736,203 +908,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/GovernmentPermit.php b/src/GovernmentPermit.php index 5508efa86..f7f439100 100644 --- a/src/GovernmentPermit.php +++ b/src/GovernmentPermit.php @@ -14,104 +14,6 @@ */ class GovernmentPermit extends BaseType implements PermitContract, IntangibleContract, ThingContract { - /** - * The organization issuing the ticket or permit. - * - * @param Organization|Organization[] $issuedBy - * - * @return static - * - * @see http://schema.org/issuedBy - */ - public function issuedBy($issuedBy) - { - return $this->setProperty('issuedBy', $issuedBy); - } - - /** - * The service through with the permit was granted. - * - * @param Service|Service[] $issuedThrough - * - * @return static - * - * @see http://schema.org/issuedThrough - */ - public function issuedThrough($issuedThrough) - { - return $this->setProperty('issuedThrough', $issuedThrough); - } - - /** - * The target audience for this permit. - * - * @param Audience|Audience[] $permitAudience - * - * @return static - * - * @see http://schema.org/permitAudience - */ - public function permitAudience($permitAudience) - { - return $this->setProperty('permitAudience', $permitAudience); - } - - /** - * The duration of validity of a permit or similar thing. - * - * @param Duration|Duration[] $validFor - * - * @return static - * - * @see http://schema.org/validFor - */ - public function validFor($validFor) - { - return $this->setProperty('validFor', $validFor); - } - - /** - * The date when the item becomes valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom - * - * @return static - * - * @see http://schema.org/validFrom - */ - public function validFrom($validFrom) - { - return $this->setProperty('validFrom', $validFrom); - } - - /** - * The geographic area where a permit or similar thing is valid. - * - * @param AdministrativeArea|AdministrativeArea[] $validIn - * - * @return static - * - * @see http://schema.org/validIn - */ - public function validIn($validIn) - { - return $this->setProperty('validIn', $validIn); - } - - /** - * The date when the item is no longer valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validUntil - * - * @return static - * - * @see http://schema.org/validUntil - */ - public function validUntil($validUntil) - { - return $this->setProperty('validUntil', $validUntil); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -209,6 +111,34 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The organization issuing the ticket or permit. + * + * @param Organization|Organization[] $issuedBy + * + * @return static + * + * @see http://schema.org/issuedBy + */ + public function issuedBy($issuedBy) + { + return $this->setProperty('issuedBy', $issuedBy); + } + + /** + * The service through with the permit was granted. + * + * @param Service|Service[] $issuedThrough + * + * @return static + * + * @see http://schema.org/issuedThrough + */ + public function issuedThrough($issuedThrough) + { + return $this->setProperty('issuedThrough', $issuedThrough); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -239,6 +169,20 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The target audience for this permit. + * + * @param Audience|Audience[] $permitAudience + * + * @return static + * + * @see http://schema.org/permitAudience + */ + public function permitAudience($permitAudience) + { + return $this->setProperty('permitAudience', $permitAudience); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -298,4 +242,60 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The duration of validity of a permit or similar thing. + * + * @param Duration|Duration[] $validFor + * + * @return static + * + * @see http://schema.org/validFor + */ + public function validFor($validFor) + { + return $this->setProperty('validFor', $validFor); + } + + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The geographic area where a permit or similar thing is valid. + * + * @param AdministrativeArea|AdministrativeArea[] $validIn + * + * @return static + * + * @see http://schema.org/validIn + */ + public function validIn($validIn) + { + return $this->setProperty('validIn', $validIn); + } + + /** + * The date when the item is no longer valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validUntil + * + * @return static + * + * @see http://schema.org/validUntil + */ + public function validUntil($validUntil) + { + return $this->setProperty('validUntil', $validUntil); + } + } diff --git a/src/GovernmentService.php b/src/GovernmentService.php index 129e31528..54217b75d 100644 --- a/src/GovernmentService.php +++ b/src/GovernmentService.php @@ -16,19 +16,22 @@ class GovernmentService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { /** - * The operating organization, if different from the provider. This enables - * the representation of services that are provided by an organization, but - * operated by another organization like a subcontractor. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $serviceOperator + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/serviceOperator + * @see http://schema.org/additionalType */ - public function serviceOperator($serviceOperator) + public function additionalType($additionalType) { - return $this->setProperty('serviceOperator', $serviceOperator); + return $this->setProperty('additionalType', $additionalType); } /** @@ -46,6 +49,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -150,6 +167,37 @@ public function category($category) return $this->setProperty('category', $category); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -179,6 +227,39 @@ public function hoursAvailable($hoursAvailable) return $this->setProperty('hoursAvailable', $hoursAvailable); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another, somehow related product (or multiple products). * @@ -222,6 +303,36 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -238,6 +349,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The tangible thing generated by the service, e.g. a passport, permit, * etc. @@ -297,6 +423,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The geographic area where the service is provided. * @@ -325,6 +467,22 @@ public function serviceAudience($serviceAudience) return $this->setProperty('serviceAudience', $serviceAudience); } + /** + * The operating organization, if different from the provider. This enables + * the representation of services that are provided by an organization, but + * operated by another organization like a subcontractor. + * + * @param Organization|Organization[] $serviceOperator + * + * @return static + * + * @see http://schema.org/serviceOperator + */ + public function serviceOperator($serviceOperator) + { + return $this->setProperty('serviceOperator', $serviceOperator); + } + /** * The tangible thing generated by the service, e.g. a passport, permit, * etc. @@ -369,164 +527,6 @@ public function slogan($slogan) return $this->setProperty('slogan', $slogan); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - /** * A CreativeWork or Event about this Thing. * diff --git a/src/GroceryStore.php b/src/GroceryStore.php index db3d921af..207e8d157 100644 --- a/src/GroceryStore.php +++ b/src/GroceryStore.php @@ -17,126 +17,104 @@ class GroceryStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HVACBusiness.php b/src/HVACBusiness.php index a752c66c2..d2a80299b 100644 --- a/src/HVACBusiness.php +++ b/src/HVACBusiness.php @@ -17,126 +17,104 @@ class HVACBusiness extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HairSalon.php b/src/HairSalon.php index 062c15802..d25ccc716 100644 --- a/src/HairSalon.php +++ b/src/HairSalon.php @@ -17,126 +17,104 @@ class HairSalon extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HardwareStore.php b/src/HardwareStore.php index f2b24ce2f..4aebd0405 100644 --- a/src/HardwareStore.php +++ b/src/HardwareStore.php @@ -17,126 +17,104 @@ class HardwareStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HealthAndBeautyBusiness.php b/src/HealthAndBeautyBusiness.php index 1b06a5dcf..20f68e6e9 100644 --- a/src/HealthAndBeautyBusiness.php +++ b/src/HealthAndBeautyBusiness.php @@ -16,126 +16,104 @@ class HealthAndBeautyBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HealthClub.php b/src/HealthClub.php index e93f94741..f7678ee3e 100644 --- a/src/HealthClub.php +++ b/src/HealthClub.php @@ -18,126 +18,104 @@ class HealthClub extends BaseType implements HealthAndBeautyBusinessContract, SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -182,6 +160,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -225,6 +238,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -242,6 +320,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -428,22 +537,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -473,6 +610,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -489,6 +673,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -547,6 +746,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -561,6 +791,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -620,6 +892,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -648,6 +934,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -678,664 +1007,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HighSchool.php b/src/HighSchool.php index 41029b46b..bdb4eae6e 100644 --- a/src/HighSchool.php +++ b/src/HighSchool.php @@ -15,17 +15,22 @@ class HighSchool extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { /** - * Alumni of an organization. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $alumni + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/alumni + * @see http://schema.org/additionalType */ - public function alumni($alumni) + public function additionalType($additionalType) { - return $this->setProperty('alumni', $alumni); + return $this->setProperty('additionalType', $additionalType); } /** @@ -57,6 +62,34 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + /** * The geographic area where a service or offered item is provided. * @@ -159,6 +192,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -390,6 +454,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -464,6 +561,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -537,6 +650,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -594,6 +721,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -646,6 +788,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -721,6 +879,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -751,203 +923,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HinduTemple.php b/src/HinduTemple.php index de9b412d2..54e5b954c 100644 --- a/src/HinduTemple.php +++ b/src/HinduTemple.php @@ -15,35 +15,6 @@ */ class HinduTemple extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/HobbyShop.php b/src/HobbyShop.php index 3aecfe5c9..92b046d96 100644 --- a/src/HobbyShop.php +++ b/src/HobbyShop.php @@ -17,126 +17,104 @@ class HobbyShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HomeAndConstructionBusiness.php b/src/HomeAndConstructionBusiness.php index f5ab07264..f488bf562 100644 --- a/src/HomeAndConstructionBusiness.php +++ b/src/HomeAndConstructionBusiness.php @@ -22,126 +22,104 @@ class HomeAndConstructionBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -186,6 +164,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -229,6 +242,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -246,6 +324,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -432,22 +541,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -477,6 +614,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -493,6 +677,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -551,6 +750,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -565,6 +795,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -624,6 +896,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -652,6 +938,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -682,664 +1011,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HomeGoodsStore.php b/src/HomeGoodsStore.php index 7498abd15..e564f8b44 100644 --- a/src/HomeGoodsStore.php +++ b/src/HomeGoodsStore.php @@ -17,126 +17,104 @@ class HomeGoodsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Hospital.php b/src/Hospital.php index 3c5f20388..d20fa7963 100644 --- a/src/Hospital.php +++ b/src/Hospital.php @@ -16,35 +16,6 @@ */ class Hospital extends BaseType implements CivicStructureContract, EmergencyServiceContract, MedicalOrganizationContract, OrganizationContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -67,6 +38,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -96,6 +86,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -114,479 +118,495 @@ public function amenityFeature($amenityFeature) } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The geographic area where a service or offered item is provided. * - * @param string|string[] $branchCode + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/areaServed */ - public function branchCode($branchCode) + public function areaServed($areaServed) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('areaServed', $areaServed); } /** - * The basic containment relation between a place and one that contains it. + * An award won by or for this item. * - * @param Place|Place[] $containedIn + * @param string|string[] $award * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/award */ - public function containedIn($containedIn) + public function award($award) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('award', $award); } /** - * The basic containment relation between a place and one that contains it. + * Awards won by or for this item. * - * @param Place|Place[] $containedInPlace + * @param string|string[] $awards * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/awards */ - public function containedInPlace($containedInPlace) + public function awards($awards) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('awards', $awards); } /** - * The basic containment relation between a place and another that it - * contains. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/branchCode */ - public function containsPlace($containsPlace) + public function branchCode($branchCode) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('branchCode', $branchCode); } /** - * Upcoming or past event associated with this place, organization, or - * action. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param Event|Event[] $event + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/event + * @see http://schema.org/branchOf */ - public function event($event) + public function branchOf($branchOf) { - return $this->setProperty('event', $event); + return $this->setProperty('branchOf', $branchOf); } /** - * Upcoming or past events associated with this place or organization. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param Event|Event[] $events + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/events + * @see http://schema.org/brand */ - public function events($events) + public function brand($brand) { - return $this->setProperty('events', $events); + return $this->setProperty('brand', $brand); } /** - * The fax number. + * A contact point for a person or organization. * - * @param string|string[] $faxNumber + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/faxNumber + * @see http://schema.org/contactPoint */ - public function faxNumber($faxNumber) + public function contactPoint($contactPoint) { - return $this->setProperty('faxNumber', $faxNumber); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The geo coordinates of the place. + * A contact point for a person or organization. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/contactPoints */ - public function geo($geo) + public function contactPoints($contactPoints) { - return $this->setProperty('geo', $geo); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $globalLocationNumber + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/containedIn */ - public function globalLocationNumber($globalLocationNumber) + public function containedIn($containedIn) { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); + return $this->setProperty('containedIn', $containedIn); } /** - * A URL to a map of the place. + * The basic containment relation between a place and one that contains it. * - * @param Map|Map[]|string|string[] $hasMap + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/containedInPlace */ - public function hasMap($hasMap) + public function containedInPlace($containedInPlace) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The basic containment relation between a place and another that it + * contains. * - * @param bool|bool[] $isAccessibleForFree + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/containsPlace */ - public function isAccessibleForFree($isAccessibleForFree) + public function containsPlace($containsPlace) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $isicV4 + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/currenciesAccepted */ - public function isicV4($isicV4) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/department */ - public function latitude($latitude) + public function department($department) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('department', $department); } /** - * An associated logo. + * A description of the item. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param string|string[] $description * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/description */ - public function logo($logo) + public function description($description) { - return $this->setProperty('logo', $logo); + return $this->setProperty('description', $description); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * 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. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/disambiguatingDescription */ - public function longitude($longitude) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A URL to a map of the place. + * The date that this organization was dissolved. * - * @param string|string[] $map + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate * * @return static * - * @see http://schema.org/map + * @see http://schema.org/dissolutionDate */ - public function map($map) + public function dissolutionDate($dissolutionDate) { - return $this->setProperty('map', $map); + return $this->setProperty('dissolutionDate', $dissolutionDate); } /** - * A URL to a map of the place. + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. * - * @param string|string[] $maps + * @param string|string[] $duns * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/duns */ - public function maps($maps) + public function duns($duns) { - return $this->setProperty('maps', $maps); + return $this->setProperty('duns', $duns); } /** - * The total number of individuals that may attend an event or venue. + * Email address. * - * @param int|int[] $maximumAttendeeCapacity + * @param string|string[] $email * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/email */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function email($email) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('email', $email); } /** - * The opening hours of a certain place. + * Someone working for this organization. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Person|Person[] $employee * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/employee */ - public function openingHoursSpecification($openingHoursSpecification) + public function employee($employee) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('employee', $employee); } /** - * A photograph of this place. + * People working for this organization. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param Person|Person[] $employees * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/employees */ - public function photo($photo) + public function employees($employees) { - return $this->setProperty('photo', $photo); + return $this->setProperty('employees', $employees); } /** - * Photographs of this place. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/event */ - public function photos($photos) + public function event($event) { - return $this->setProperty('photos', $photos); + return $this->setProperty('event', $event); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * Upcoming or past events associated with this place or organization. * - * @param bool|bool[] $publicAccess + * @param Event|Event[] $events * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/events */ - public function publicAccess($publicAccess) + public function events($events) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('events', $events); } /** - * A review of the item. + * The fax number. * - * @param Review|Review[] $review + * @param string|string[] $faxNumber * * @return static * - * @see http://schema.org/review + * @see http://schema.org/faxNumber */ - public function review($review) + public function faxNumber($faxNumber) { - return $this->setProperty('review', $review); + return $this->setProperty('faxNumber', $faxNumber); } /** - * Review of the item. + * A person who founded this organization. * - * @param Review|Review[] $reviews + * @param Person|Person[] $founder * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/founder */ - public function reviews($reviews) + public function founder($founder) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('founder', $founder); } /** - * A slogan or motto associated with the item. + * A person who founded this organization. * - * @param string|string[] $slogan + * @param Person|Person[] $founders * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/founders */ - public function slogan($slogan) + public function founders($founders) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('founders', $founders); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * The date that this organization was founded. * - * @param bool|bool[] $smokingAllowed + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/foundingDate */ - public function smokingAllowed($smokingAllowed) + public function foundingDate($foundingDate) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('foundingDate', $foundingDate); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The place where the Organization was founded. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param Place|Place[] $foundingLocation * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/foundingLocation */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function foundingLocation($foundingLocation) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('foundingLocation', $foundingLocation); } /** - * The telephone number. + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $funder * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/funder */ - public function telephone($telephone) + public function funder($funder) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('funder', $funder); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geo coordinates of the place. * - * @param string|string[] $additionalType + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/geo */ - public function additionalType($additionalType) + public function geo($geo) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('geo', $geo); } /** - * An alias for the item. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $alternateName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/globalLocationNumber */ - public function alternateName($alternateName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * A description of the item. + * A URL to a map of the place. * - * @param string|string[] $description + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/description + * @see http://schema.org/hasMap */ - public function description($description) + public function hasMap($hasMap) { - return $this->setProperty('description', $description); + return $this->setProperty('hasMap', $hasMap); } /** - * 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. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param string|string[] $disambiguatingDescription + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/hasOfferCatalog */ - public function disambiguatingDescription($disambiguatingDescription) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); } /** @@ -623,657 +643,595 @@ public function image($image) } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A flag to signal that the item, event, or place is accessible for free. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/isAccessibleForFree */ - public function mainEntityOfPage($mainEntityOfPage) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The name of the item. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $name + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/name + * @see http://schema.org/isicV4 */ - public function name($name) + public function isicV4($isicV4) { - return $this->setProperty('name', $name); + return $this->setProperty('isicV4', $isicV4); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/latitude */ - public function potentialAction($potentialAction) + public function latitude($latitude) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('latitude', $latitude); } /** - * 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. + * The official name of the organization, e.g. the registered company name. * - * @param string|string[] $sameAs + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/legalName */ - public function sameAs($sameAs) + public function legalName($legalName) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('legalName', $legalName); } /** - * A CreativeWork or Event about this Thing. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/leiCode */ - public function subjectOf($subjectOf) + public function leiCode($leiCode) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $currenciesAccepted - * - * @return static - * - * @see http://schema.org/currenciesAccepted - */ - public function currenciesAccepted($currenciesAccepted) - { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); - } - - /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. - * - * @param string|string[] $paymentAccepted - * - * @return static - * - * @see http://schema.org/paymentAccepted - */ - public function paymentAccepted($paymentAccepted) - { - return $this->setProperty('paymentAccepted', $paymentAccepted); - } - - /** - * The price range of the business, for example ```$$$```. - * - * @param string|string[] $priceRange - * - * @return static - * - * @see http://schema.org/priceRange - */ - public function priceRange($priceRange) - { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('leiCode', $leiCode); } /** - * The geographic area where a service or offered item is provided. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/location */ - public function areaServed($areaServed) + public function location($location) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('location', $location); } /** - * An award won by or for this item. + * An associated logo. * - * @param string|string[] $award + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/award + * @see http://schema.org/logo */ - public function award($award) + public function logo($logo) { - return $this->setProperty('award', $award); + return $this->setProperty('logo', $logo); } /** - * Awards won by or for this item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $awards + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/longitude */ - public function awards($awards) + public function longitude($longitude) { - return $this->setProperty('awards', $awards); + return $this->setProperty('longitude', $longitude); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/mainEntityOfPage */ - public function brand($brand) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('brand', $brand); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A contact point for a person or organization. + * A pointer to products or services offered by the organization or person. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/makesOffer */ - public function contactPoint($contactPoint) + public function makesOffer($makesOffer) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A contact point for a person or organization. + * A URL to a map of the place. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $map * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/map */ - public function contactPoints($contactPoints) + public function map($map) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('map', $map); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * A URL to a map of the place. * - * @param Organization|Organization[] $department + * @param string|string[] $maps * * @return static * - * @see http://schema.org/department + * @see http://schema.org/maps */ - public function department($department) + public function maps($maps) { - return $this->setProperty('department', $department); + return $this->setProperty('maps', $maps); } /** - * The date that this organization was dissolved. + * The total number of individuals that may attend an event or venue. * - * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/dissolutionDate + * @see http://schema.org/maximumAttendeeCapacity */ - public function dissolutionDate($dissolutionDate) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('dissolutionDate', $dissolutionDate); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * The Dun & Bradstreet DUNS number for identifying an organization or - * business person. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param string|string[] $duns + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/duns + * @see http://schema.org/member */ - public function duns($duns) + public function member($member) { - return $this->setProperty('duns', $duns); + return $this->setProperty('member', $member); } /** - * Email address. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $email + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/email + * @see http://schema.org/memberOf */ - public function email($email) + public function memberOf($memberOf) { - return $this->setProperty('email', $email); + return $this->setProperty('memberOf', $memberOf); } /** - * Someone working for this organization. + * A member of this organization. * - * @param Person|Person[] $employee + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/employee + * @see http://schema.org/members */ - public function employee($employee) + public function members($members) { - return $this->setProperty('employee', $employee); + return $this->setProperty('members', $members); } /** - * People working for this organization. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param Person|Person[] $employees + * @param string|string[] $naics * * @return static * - * @see http://schema.org/employees + * @see http://schema.org/naics */ - public function employees($employees) + public function naics($naics) { - return $this->setProperty('employees', $employees); + return $this->setProperty('naics', $naics); } /** - * A person who founded this organization. + * The name of the item. * - * @param Person|Person[] $founder + * @param string|string[] $name * * @return static * - * @see http://schema.org/founder + * @see http://schema.org/name */ - public function founder($founder) + public function name($name) { - return $this->setProperty('founder', $founder); + return $this->setProperty('name', $name); } /** - * A person who founded this organization. + * The number of employees in an organization e.g. business. * - * @param Person|Person[] $founders + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/founders + * @see http://schema.org/numberOfEmployees */ - public function founders($founders) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('founders', $founders); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * The date that this organization was founded. + * A pointer to the organization or person making the offer. * - * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/foundingDate + * @see http://schema.org/offeredBy */ - public function foundingDate($foundingDate) + public function offeredBy($offeredBy) { - return $this->setProperty('foundingDate', $foundingDate); + return $this->setProperty('offeredBy', $offeredBy); } /** - * The place where the Organization was founded. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param Place|Place[] $foundingLocation + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/foundingLocation + * @see http://schema.org/openingHours */ - public function foundingLocation($foundingLocation) + public function openingHours($openingHours) { - return $this->setProperty('foundingLocation', $foundingLocation); + return $this->setProperty('openingHours', $openingHours); } /** - * A person or organization that supports (sponsors) something through some - * kind of financial contribution. + * The opening hours of a certain place. * - * @param Organization|Organization[]|Person|Person[] $funder + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/funder + * @see http://schema.org/openingHoursSpecification */ - public function funder($funder) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('funder', $funder); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * Products owned by the organization or person. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/owns */ - public function hasOfferCatalog($hasOfferCatalog) + public function owns($owns) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('owns', $owns); } /** - * Points-of-Sales operated by the organization or person. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param Place|Place[] $hasPOS + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/hasPOS + * @see http://schema.org/parentOrganization */ - public function hasPOS($hasPOS) + public function parentOrganization($parentOrganization) { - return $this->setProperty('hasPOS', $hasPOS); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The official name of the organization, e.g. the registered company name. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $legalName + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/paymentAccepted */ - public function legalName($legalName) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A photograph of this place. * - * @param string|string[] $leiCode + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/photo */ - public function leiCode($leiCode) + public function photo($photo) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('photo', $photo); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Photographs of this place. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/location + * @see http://schema.org/photos */ - public function location($location) + public function photos($photos) { - return $this->setProperty('location', $location); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services offered by the organization or person. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Offer|Offer[] $makesOffer + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/potentialAction */ - public function makesOffer($makesOffer) + public function potentialAction($potentialAction) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * The price range of the business, for example ```$$$```. * - * @param Organization|Organization[]|Person|Person[] $member + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/member + * @see http://schema.org/priceRange */ - public function member($member) + public function priceRange($priceRange) { - return $this->setProperty('member', $member); + return $this->setProperty('priceRange', $priceRange); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/publicAccess */ - public function memberOf($memberOf) + public function publicAccess($publicAccess) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A member of this organization. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $members + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/members + * @see http://schema.org/publishingPrinciples */ - public function members($members) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('members', $members); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * A review of the item. * - * @param string|string[] $naics + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/review */ - public function naics($naics) + public function review($review) { - return $this->setProperty('naics', $naics); + return $this->setProperty('review', $review); } /** - * The number of employees in an organization e.g. business. + * Review of the item. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/reviews */ - public function numberOfEmployees($numberOfEmployees) + public function reviews($reviews) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('reviews', $reviews); } /** - * A pointer to the organization or person making the offer. + * 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. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/sameAs */ - public function offeredBy($offeredBy) + public function sameAs($sameAs) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('sameAs', $sameAs); } /** - * Products owned by the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/seeks */ - public function owns($owns) + public function seeks($seeks) { - return $this->setProperty('owns', $owns); + return $this->setProperty('seeks', $seeks); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The geographic area where the service is provided. * - * @param Organization|Organization[] $parentOrganization + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/serviceArea */ - public function parentOrganization($parentOrganization) + public function serviceArea($serviceArea) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('serviceArea', $serviceArea); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/slogan */ - public function publishingPrinciples($publishingPrinciples) + public function slogan($slogan) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('slogan', $slogan); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param Demand|Demand[] $seeks + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/smokingAllowed */ - public function seeks($seeks) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * The geographic area where the service is provided. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/specialOpeningHoursSpecification */ - public function serviceArea($serviceArea) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** @@ -1308,6 +1266,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -1323,6 +1295,34 @@ public function taxID($taxID) return $this->setProperty('taxID', $taxID); } + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The Value-added Tax ID of the organization or person. * diff --git a/src/Hostel.php b/src/Hostel.php index edb19f2d2..49e5ed058 100644 --- a/src/Hostel.php +++ b/src/Hostel.php @@ -20,352 +20,395 @@ class Hostel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/additionalProperty */ - public function amenityFeature($amenityFeature) + public function additionalProperty($additionalProperty) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * An intended audience, i.e. a group for whom something was created. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Audience|Audience[] $audience + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/additionalType */ - public function audience($audience) + public function additionalType($additionalType) { - return $this->setProperty('audience', $audience); + return $this->setProperty('additionalType', $additionalType); } /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * Physical address of the item. * - * @param Language|Language[]|string|string[] $availableLanguage + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/availableLanguage + * @see http://schema.org/address */ - public function availableLanguage($availableLanguage) + public function address($address) { - return $this->setProperty('availableLanguage', $availableLanguage); + return $this->setProperty('address', $address); } /** - * The earliest someone may check into a lodging establishment. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/checkinTime + * @see http://schema.org/aggregateRating */ - public function checkinTime($checkinTime) + public function aggregateRating($aggregateRating) { - return $this->setProperty('checkinTime', $checkinTime); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The latest someone may check out of a lodging establishment. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/checkoutTime + * @see http://schema.org/alternateName */ - public function checkoutTime($checkoutTime) + public function alternateName($alternateName) { - return $this->setProperty('checkoutTime', $checkoutTime); + return $this->setProperty('alternateName', $alternateName); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/amenityFeature */ - public function numberOfRooms($numberOfRooms) + public function amenityFeature($amenityFeature) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * The geographic area where a service or offered item is provided. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/areaServed */ - public function petsAllowed($petsAllowed) + public function areaServed($areaServed) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('areaServed', $areaServed); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * An intended audience, i.e. a group for whom something was created. * - * @param Rating|Rating[] $starRating + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/audience */ - public function starRating($starRating) + public function audience($audience) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('audience', $audience); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] * - * @param Organization|Organization[] $branchOf + * @param Language|Language[]|string|string[] $availableLanguage * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/availableLanguage */ - public function branchOf($branchOf) + public function availableLanguage($availableLanguage) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('availableLanguage', $availableLanguage); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An award won by or for this item. * - * @param string|string[] $currenciesAccepted + * @param string|string[] $award * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/award */ - public function currenciesAccepted($currenciesAccepted) + public function award($award) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('award', $award); } /** - * 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 '-'. + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * The earliest someone may check into a lodging establishment. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime * * @return static * - * @see http://schema.org/address + * @see http://schema.org/checkinTime */ - public function address($address) + public function checkinTime($checkinTime) { - return $this->setProperty('address', $address); + return $this->setProperty('checkinTime', $checkinTime); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The latest someone may check out of a lodging establishment. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/checkoutTime */ - public function aggregateRating($aggregateRating) + public function checkoutTime($checkoutTime) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('checkoutTime', $checkoutTime); } /** - * The geographic area where a service or offered item is provided. + * A contact point for a person or organization. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/contactPoint */ - public function areaServed($areaServed) + public function contactPoint($contactPoint) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('contactPoint', $contactPoint); } /** - * An award won by or for this item. + * A contact point for a person or organization. * - * @param string|string[] $award + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/award + * @see http://schema.org/contactPoints */ - public function award($award) + public function contactPoints($contactPoints) { - return $this->setProperty('award', $award); + return $this->setProperty('contactPoints', $contactPoints); } /** - * Awards won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $awards + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containedIn */ - public function awards($awards) + public function containedIn($containedIn) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containedIn', $containedIn); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The basic containment relation between a place and one that contains it. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/containedInPlace */ - public function brand($brand) + public function containedInPlace($containedInPlace) { - return $this->setProperty('brand', $brand); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A contact point for a person or organization. + * The basic containment relation between a place and another that it + * contains. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -553,6 +596,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -570,6 +627,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -600,851 +671,780 @@ public function hasPOS($hasPOS) } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. - * - * @param string|string[] $isicV4 - * - * @return static - * - * @see http://schema.org/isicV4 - */ - public function isicV4($isicV4) - { - return $this->setProperty('isicV4', $isicV4); - } - - /** - * The official name of the organization, e.g. the registered company name. - * - * @param string|string[] $legalName - * - * @return static - * - * @see http://schema.org/legalName - */ - public function legalName($legalName) - { - return $this->setProperty('legalName', $legalName); - } - - /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. - * - * @param string|string[] $leiCode - * - * @return static - * - * @see http://schema.org/leiCode - */ - public function leiCode($leiCode) - { - return $this->setProperty('leiCode', $leiCode); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * An associated logo. - * - * @param ImageObject|ImageObject[]|string|string[] $logo - * - * @return static - * - * @see http://schema.org/logo - */ - public function logo($logo) - { - return $this->setProperty('logo', $logo); - } - - /** - * A pointer to products or services offered by the organization or person. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $makesOffer + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/identifier */ - public function makesOffer($makesOffer) + public function identifier($identifier) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('identifier', $identifier); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $member + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/member + * @see http://schema.org/image */ - public function member($member) + public function image($image) { - return $this->setProperty('member', $member); + return $this->setProperty('image', $image); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/isAccessibleForFree */ - public function memberOf($memberOf) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * A member of this organization. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param Organization|Organization[]|Person|Person[] $members + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isicV4 */ - public function members($members) + public function isicV4($isicV4) { - return $this->setProperty('members', $members); + return $this->setProperty('isicV4', $isicV4); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $naics + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/latitude */ - public function naics($naics) + public function latitude($latitude) { - return $this->setProperty('naics', $naics); + return $this->setProperty('latitude', $latitude); } /** - * The number of employees in an organization e.g. business. + * The official name of the organization, e.g. the registered company name. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/legalName */ - public function numberOfEmployees($numberOfEmployees) + public function legalName($legalName) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('legalName', $legalName); } /** - * A pointer to the organization or person making the offer. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/leiCode */ - public function offeredBy($offeredBy) + public function leiCode($leiCode) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('leiCode', $leiCode); } /** - * Products owned by the organization or person. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/location */ - public function owns($owns) + public function location($location) { - return $this->setProperty('owns', $owns); + return $this->setProperty('location', $location); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * An associated logo. * - * @param Organization|Organization[] $parentOrganization + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/logo */ - public function parentOrganization($parentOrganization) + public function logo($logo) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('logo', $logo); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/longitude */ - public function publishingPrinciples($publishingPrinciples) + public function longitude($longitude) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('longitude', $longitude); } /** - * A review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $review + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/review + * @see http://schema.org/mainEntityOfPage */ - public function review($review) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('review', $review); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Review of the item. + * A pointer to products or services offered by the organization or person. * - * @param Review|Review[] $reviews + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/makesOffer */ - public function reviews($reviews) + public function makesOffer($makesOffer) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A URL to a map of the place. * - * @param Demand|Demand[] $seeks + * @param string|string[] $map * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/map */ - public function seeks($seeks) + public function map($map) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('map', $map); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $maps * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/maps */ - public function serviceArea($serviceArea) + public function maps($maps) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('maps', $maps); } /** - * A slogan or motto associated with the item. + * The total number of individuals that may attend an event or venue. * - * @param string|string[] $slogan + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maximumAttendeeCapacity */ - public function slogan($slogan) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * 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. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/member */ - public function sponsor($sponsor) + public function member($member) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('member', $member); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/memberOf */ - public function subOrganization($subOrganization) + public function memberOf($memberOf) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('memberOf', $memberOf); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * A member of this organization. * - * @param string|string[] $taxID + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/members */ - public function taxID($taxID) + public function members($members) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('members', $members); } /** - * The telephone number. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $telephone + * @param string|string[] $naics * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/naics */ - public function telephone($telephone) + public function naics($naics) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('naics', $naics); } /** - * The Value-added Tax ID of the organization or person. + * The name of the item. * - * @param string|string[] $vatID + * @param string|string[] $name * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/name */ - public function vatID($vatID) + public function name($name) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The number of employees in an organization e.g. business. * - * @param string|string[] $additionalType + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/numberOfEmployees */ - public function additionalType($additionalType) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * An alias for the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param string|string[] $alternateName + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/numberOfRooms */ - public function alternateName($alternateName) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A description of the item. + * A pointer to the organization or person making the offer. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/description + * @see http://schema.org/offeredBy */ - public function description($description) + public function offeredBy($offeredBy) { - return $this->setProperty('description', $description); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/openingHours */ - public function disambiguatingDescription($disambiguatingDescription) + public function openingHours($openingHours) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('openingHours', $openingHours); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The opening hours of a certain place. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHoursSpecification */ - public function identifier($identifier) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Products owned by the organization or person. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/image + * @see http://schema.org/owns */ - public function image($image) + public function owns($owns) { - return $this->setProperty('image', $image); + return $this->setProperty('owns', $owns); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/parentOrganization */ - public function mainEntityOfPage($mainEntityOfPage) + public function parentOrganization($parentOrganization) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The name of the item. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $name + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/name + * @see http://schema.org/paymentAccepted */ - public function name($name) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('name', $name); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param Action|Action[] $potentialAction + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/petsAllowed */ - public function potentialAction($potentialAction) + public function petsAllowed($petsAllowed) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $branchCode + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publicAccess */ - public function branchCode($branchCode) + public function publicAccess($publicAccess) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedIn + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publishingPrinciples */ - public function containedIn($containedIn) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/review */ - public function containedInPlace($containedInPlace) + public function review($review) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and another that it - * contains. + * Review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/reviews */ - public function containsPlace($containsPlace) + public function reviews($reviews) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('reviews', $reviews); } /** - * The geo coordinates of the place. + * 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. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/sameAs */ - public function geo($geo) + public function sameAs($sameAs) { - return $this->setProperty('geo', $geo); + return $this->setProperty('sameAs', $sameAs); } /** - * A URL to a map of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param Map|Map[]|string|string[] $hasMap + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/seeks */ - public function hasMap($hasMap) + public function seeks($seeks) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('seeks', $seeks); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Hotel.php b/src/Hotel.php index 1dd053b67..7b129ca95 100644 --- a/src/Hotel.php +++ b/src/Hotel.php @@ -22,352 +22,395 @@ class Hotel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/additionalProperty */ - public function amenityFeature($amenityFeature) + public function additionalProperty($additionalProperty) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * An intended audience, i.e. a group for whom something was created. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Audience|Audience[] $audience + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/additionalType */ - public function audience($audience) + public function additionalType($additionalType) { - return $this->setProperty('audience', $audience); + return $this->setProperty('additionalType', $additionalType); } /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * Physical address of the item. * - * @param Language|Language[]|string|string[] $availableLanguage + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/availableLanguage + * @see http://schema.org/address */ - public function availableLanguage($availableLanguage) + public function address($address) { - return $this->setProperty('availableLanguage', $availableLanguage); + return $this->setProperty('address', $address); } /** - * The earliest someone may check into a lodging establishment. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/checkinTime + * @see http://schema.org/aggregateRating */ - public function checkinTime($checkinTime) + public function aggregateRating($aggregateRating) { - return $this->setProperty('checkinTime', $checkinTime); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The latest someone may check out of a lodging establishment. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/checkoutTime + * @see http://schema.org/alternateName */ - public function checkoutTime($checkoutTime) + public function alternateName($alternateName) { - return $this->setProperty('checkoutTime', $checkoutTime); + return $this->setProperty('alternateName', $alternateName); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/amenityFeature */ - public function numberOfRooms($numberOfRooms) + public function amenityFeature($amenityFeature) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * The geographic area where a service or offered item is provided. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/areaServed */ - public function petsAllowed($petsAllowed) + public function areaServed($areaServed) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('areaServed', $areaServed); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * An intended audience, i.e. a group for whom something was created. * - * @param Rating|Rating[] $starRating + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/audience */ - public function starRating($starRating) + public function audience($audience) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('audience', $audience); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] * - * @param Organization|Organization[] $branchOf + * @param Language|Language[]|string|string[] $availableLanguage * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/availableLanguage */ - public function branchOf($branchOf) + public function availableLanguage($availableLanguage) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('availableLanguage', $availableLanguage); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An award won by or for this item. * - * @param string|string[] $currenciesAccepted + * @param string|string[] $award * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/award */ - public function currenciesAccepted($currenciesAccepted) + public function award($award) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('award', $award); } /** - * 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 '-'. + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * The earliest someone may check into a lodging establishment. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime * * @return static * - * @see http://schema.org/address + * @see http://schema.org/checkinTime */ - public function address($address) + public function checkinTime($checkinTime) { - return $this->setProperty('address', $address); + return $this->setProperty('checkinTime', $checkinTime); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The latest someone may check out of a lodging establishment. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/checkoutTime */ - public function aggregateRating($aggregateRating) + public function checkoutTime($checkoutTime) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('checkoutTime', $checkoutTime); } /** - * The geographic area where a service or offered item is provided. + * A contact point for a person or organization. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/contactPoint */ - public function areaServed($areaServed) + public function contactPoint($contactPoint) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('contactPoint', $contactPoint); } /** - * An award won by or for this item. + * A contact point for a person or organization. * - * @param string|string[] $award + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/award + * @see http://schema.org/contactPoints */ - public function award($award) + public function contactPoints($contactPoints) { - return $this->setProperty('award', $award); + return $this->setProperty('contactPoints', $contactPoints); } /** - * Awards won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $awards + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containedIn */ - public function awards($awards) + public function containedIn($containedIn) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containedIn', $containedIn); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The basic containment relation between a place and one that contains it. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/containedInPlace */ - public function brand($brand) + public function containedInPlace($containedInPlace) { - return $this->setProperty('brand', $brand); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A contact point for a person or organization. + * The basic containment relation between a place and another that it + * contains. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -555,6 +598,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -572,6 +629,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -602,851 +673,780 @@ public function hasPOS($hasPOS) } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. - * - * @param string|string[] $isicV4 - * - * @return static - * - * @see http://schema.org/isicV4 - */ - public function isicV4($isicV4) - { - return $this->setProperty('isicV4', $isicV4); - } - - /** - * The official name of the organization, e.g. the registered company name. - * - * @param string|string[] $legalName - * - * @return static - * - * @see http://schema.org/legalName - */ - public function legalName($legalName) - { - return $this->setProperty('legalName', $legalName); - } - - /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. - * - * @param string|string[] $leiCode - * - * @return static - * - * @see http://schema.org/leiCode - */ - public function leiCode($leiCode) - { - return $this->setProperty('leiCode', $leiCode); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * An associated logo. - * - * @param ImageObject|ImageObject[]|string|string[] $logo - * - * @return static - * - * @see http://schema.org/logo - */ - public function logo($logo) - { - return $this->setProperty('logo', $logo); - } - - /** - * A pointer to products or services offered by the organization or person. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $makesOffer + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/identifier */ - public function makesOffer($makesOffer) + public function identifier($identifier) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('identifier', $identifier); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $member + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/member + * @see http://schema.org/image */ - public function member($member) + public function image($image) { - return $this->setProperty('member', $member); + return $this->setProperty('image', $image); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/isAccessibleForFree */ - public function memberOf($memberOf) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * A member of this organization. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param Organization|Organization[]|Person|Person[] $members + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isicV4 */ - public function members($members) + public function isicV4($isicV4) { - return $this->setProperty('members', $members); + return $this->setProperty('isicV4', $isicV4); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $naics + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/latitude */ - public function naics($naics) + public function latitude($latitude) { - return $this->setProperty('naics', $naics); + return $this->setProperty('latitude', $latitude); } /** - * The number of employees in an organization e.g. business. + * The official name of the organization, e.g. the registered company name. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/legalName */ - public function numberOfEmployees($numberOfEmployees) + public function legalName($legalName) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('legalName', $legalName); } /** - * A pointer to the organization or person making the offer. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/leiCode */ - public function offeredBy($offeredBy) + public function leiCode($leiCode) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('leiCode', $leiCode); } /** - * Products owned by the organization or person. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/location */ - public function owns($owns) + public function location($location) { - return $this->setProperty('owns', $owns); + return $this->setProperty('location', $location); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * An associated logo. * - * @param Organization|Organization[] $parentOrganization + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/logo */ - public function parentOrganization($parentOrganization) + public function logo($logo) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('logo', $logo); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/longitude */ - public function publishingPrinciples($publishingPrinciples) + public function longitude($longitude) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('longitude', $longitude); } /** - * A review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $review + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/review + * @see http://schema.org/mainEntityOfPage */ - public function review($review) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('review', $review); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Review of the item. + * A pointer to products or services offered by the organization or person. * - * @param Review|Review[] $reviews + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/makesOffer */ - public function reviews($reviews) + public function makesOffer($makesOffer) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A URL to a map of the place. * - * @param Demand|Demand[] $seeks + * @param string|string[] $map * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/map */ - public function seeks($seeks) + public function map($map) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('map', $map); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $maps * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/maps */ - public function serviceArea($serviceArea) + public function maps($maps) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('maps', $maps); } /** - * A slogan or motto associated with the item. + * The total number of individuals that may attend an event or venue. * - * @param string|string[] $slogan + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maximumAttendeeCapacity */ - public function slogan($slogan) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * 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. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/member */ - public function sponsor($sponsor) + public function member($member) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('member', $member); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/memberOf */ - public function subOrganization($subOrganization) + public function memberOf($memberOf) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('memberOf', $memberOf); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * A member of this organization. * - * @param string|string[] $taxID + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/members */ - public function taxID($taxID) + public function members($members) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('members', $members); } /** - * The telephone number. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $telephone + * @param string|string[] $naics * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/naics */ - public function telephone($telephone) + public function naics($naics) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('naics', $naics); } /** - * The Value-added Tax ID of the organization or person. + * The name of the item. * - * @param string|string[] $vatID + * @param string|string[] $name * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/name */ - public function vatID($vatID) + public function name($name) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The number of employees in an organization e.g. business. * - * @param string|string[] $additionalType + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/numberOfEmployees */ - public function additionalType($additionalType) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * An alias for the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param string|string[] $alternateName + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/numberOfRooms */ - public function alternateName($alternateName) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A description of the item. + * A pointer to the organization or person making the offer. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/description + * @see http://schema.org/offeredBy */ - public function description($description) + public function offeredBy($offeredBy) { - return $this->setProperty('description', $description); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/openingHours */ - public function disambiguatingDescription($disambiguatingDescription) + public function openingHours($openingHours) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('openingHours', $openingHours); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The opening hours of a certain place. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHoursSpecification */ - public function identifier($identifier) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Products owned by the organization or person. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/image + * @see http://schema.org/owns */ - public function image($image) + public function owns($owns) { - return $this->setProperty('image', $image); + return $this->setProperty('owns', $owns); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/parentOrganization */ - public function mainEntityOfPage($mainEntityOfPage) + public function parentOrganization($parentOrganization) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The name of the item. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $name + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/name + * @see http://schema.org/paymentAccepted */ - public function name($name) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('name', $name); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param Action|Action[] $potentialAction + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/petsAllowed */ - public function potentialAction($potentialAction) + public function petsAllowed($petsAllowed) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $branchCode + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publicAccess */ - public function branchCode($branchCode) + public function publicAccess($publicAccess) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedIn + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publishingPrinciples */ - public function containedIn($containedIn) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/review */ - public function containedInPlace($containedInPlace) + public function review($review) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and another that it - * contains. + * Review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/reviews */ - public function containsPlace($containsPlace) + public function reviews($reviews) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('reviews', $reviews); } /** - * The geo coordinates of the place. + * 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. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/sameAs */ - public function geo($geo) + public function sameAs($sameAs) { - return $this->setProperty('geo', $geo); + return $this->setProperty('sameAs', $sameAs); } /** - * A URL to a map of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param Map|Map[]|string|string[] $hasMap + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/seeks */ - public function hasMap($hasMap) + public function seeks($seeks) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('seeks', $seeks); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HotelRoom.php b/src/HotelRoom.php index 5e7d6fcad..4184c1214 100644 --- a/src/HotelRoom.php +++ b/src/HotelRoom.php @@ -19,169 +19,122 @@ class HotelRoom extends BaseType implements RoomContract, AccommodationContract, PlaceContract, ThingContract { /** - * The type of bed or beds included in the accommodation. For the single - * case of just one bed of a certain type, you use bed directly with a text. - * If you want to indicate the quantity of a certain kind of bed, use - * an instance of BedDetails. For more detailed information, use the - * amenityFeature property. - * - * @param BedDetails|BedDetails[]|string|string[] $bed - * - * @return static - * - * @see http://schema.org/bed - */ - public function bed($bed) - { - return $this->setProperty('bed', $bed); - } - - /** - * The allowed total occupancy for the accommodation in persons (including - * infants etc). For individual accommodations, this is not necessarily the - * legal maximum but defines the permitted usage as per the contractual - * agreement (e.g. a double room used by a single person). - * Typical unit code(s): C62 for person - * - * @param QuantitativeValue|QuantitativeValue[] $occupancy - * - * @return static - * - * @see http://schema.org/occupancy - */ - public function occupancy($occupancy) - { - return $this->setProperty('occupancy', $occupancy); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[] $floorSize + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/floorSize + * @see http://schema.org/additionalProperty */ - public function floorSize($floorSize) + public function additionalProperty($additionalProperty) { - return $this->setProperty('floorSize', $floorSize); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/additionalType */ - public function numberOfRooms($numberOfRooms) + public function additionalType($additionalType) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('additionalType', $additionalType); } /** - * Indications regarding the permitted usage of the accommodation. + * Physical address of the item. * - * @param string|string[] $permittedUsage + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/permittedUsage + * @see http://schema.org/address */ - public function permittedUsage($permittedUsage) + public function address($address) { - return $this->setProperty('permittedUsage', $permittedUsage); + return $this->setProperty('address', $address); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/aggregateRating */ - public function petsAllowed($petsAllowed) + public function aggregateRating($aggregateRating) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * An alias for the item. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/alternateName */ - public function additionalProperty($additionalProperty) + public function alternateName($alternateName) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('alternateName', $alternateName); } /** - * Physical address of the item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/address + * @see http://schema.org/amenityFeature */ - public function address($address) + public function amenityFeature($amenityFeature) { - return $this->setProperty('address', $address); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The type of bed or beds included in the accommodation. For the single + * case of just one bed of a certain type, you use bed directly with a text. + * If you want to indicate the quantity of a certain kind of bed, use + * an instance of BedDetails. For more detailed information, use the + * amenityFeature property. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param BedDetails|BedDetails[]|string|string[] $bed * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/bed */ - public function aggregateRating($aggregateRating) + public function bed($bed) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('bed', $bed); } /** @@ -247,6 +200,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -290,6 +274,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -335,6 +335,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -409,6 +442,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -452,320 +501,271 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The name of the item. * - * @param bool|bool[] $publicAccess + * @param string|string[] $name * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/name */ - public function publicAccess($publicAccess) + public function name($name) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('name', $name); } /** - * A review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $review + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/review + * @see http://schema.org/numberOfRooms */ - public function review($review) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('review', $review); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * Review of the item. + * The allowed total occupancy for the accommodation in persons (including + * infants etc). For individual accommodations, this is not necessarily the + * legal maximum but defines the permitted usage as per the contractual + * agreement (e.g. a double room used by a single person). + * Typical unit code(s): C62 for person * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[] $occupancy * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/occupancy */ - public function reviews($reviews) + public function occupancy($occupancy) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('occupancy', $occupancy); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/House.php b/src/House.php index 9f9d3a486..c6376034a 100644 --- a/src/House.php +++ b/src/House.php @@ -18,150 +18,104 @@ class House extends BaseType implements AccommodationContract, PlaceContract, ThingContract { /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms - * - * @return static - * - * @see http://schema.org/numberOfRooms - */ - public function numberOfRooms($numberOfRooms) - { - return $this->setProperty('numberOfRooms', $numberOfRooms); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard - * - * @param QuantitativeValue|QuantitativeValue[] $floorSize - * - * @return static - * - * @see http://schema.org/floorSize - */ - public function floorSize($floorSize) - { - return $this->setProperty('floorSize', $floorSize); - } - - /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/additionalProperty */ - public function numberOfRooms($numberOfRooms) + public function additionalProperty($additionalProperty) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Indications regarding the permitted usage of the accommodation. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $permittedUsage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/permittedUsage + * @see http://schema.org/additionalType */ - public function permittedUsage($permittedUsage) + public function additionalType($additionalType) { - return $this->setProperty('permittedUsage', $permittedUsage); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * Physical address of the item. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/address */ - public function petsAllowed($petsAllowed) + public function address($address) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('address', $address); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/aggregateRating */ - public function additionalProperty($additionalProperty) + public function aggregateRating($aggregateRating) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -227,6 +181,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -270,6 +255,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -315,6 +316,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -389,6 +423,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -432,320 +482,253 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * A review of the item. + * The name of the item. * - * @param Review|Review[] $review + * @param string|string[] $name * * @return static * - * @see http://schema.org/review + * @see http://schema.org/name */ - public function review($review) + public function name($name) { - return $this->setProperty('review', $review); + return $this->setProperty('name', $name); } /** - * Review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/numberOfRooms */ - public function reviews($reviews) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/HousePainter.php b/src/HousePainter.php index 663e04e5e..06d5d3e6b 100644 --- a/src/HousePainter.php +++ b/src/HousePainter.php @@ -17,126 +17,104 @@ class HousePainter extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/HowTo.php b/src/HowTo.php index 72d9c372e..fad88bee7 100644 --- a/src/HowTo.php +++ b/src/HowTo.php @@ -14,144 +14,6 @@ */ class HowTo extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The estimated cost of the supply or supplies consumed when performing - * instructions. - * - * @param MonetaryAmount|MonetaryAmount[]|string|string[] $estimatedCost - * - * @return static - * - * @see http://schema.org/estimatedCost - */ - public function estimatedCost($estimatedCost) - { - return $this->setProperty('estimatedCost', $estimatedCost); - } - - /** - * The length of time it takes to perform instructions or a direction (not - * including time to prepare the supplies), in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $performTime - * - * @return static - * - * @see http://schema.org/performTime - */ - public function performTime($performTime) - { - return $this->setProperty('performTime', $performTime); - } - - /** - * The length of time it takes to prepare the items to be used in - * instructions or a direction, in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $prepTime - * - * @return static - * - * @see http://schema.org/prepTime - */ - public function prepTime($prepTime) - { - return $this->setProperty('prepTime', $prepTime); - } - - /** - * A single step item (as HowToStep, text, document, video, etc.) or a - * HowToSection. - * - * @param CreativeWork|CreativeWork[]|HowToSection|HowToSection[]|HowToStep|HowToStep[]|string|string[] $step - * - * @return static - * - * @see http://schema.org/step - */ - public function step($step) - { - return $this->setProperty('step', $step); - } - - /** - * A single step item (as HowToStep, text, document, video, etc.) or a - * HowToSection (originally misnamed 'steps'; 'step' is preferred). - * - * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $steps - * - * @return static - * - * @see http://schema.org/steps - */ - public function steps($steps) - { - return $this->setProperty('steps', $steps); - } - - /** - * A sub-property of instrument. A supply consumed when performing - * instructions or a direction. - * - * @param HowToSupply|HowToSupply[]|string|string[] $supply - * - * @return static - * - * @see http://schema.org/supply - */ - public function supply($supply) - { - return $this->setProperty('supply', $supply); - } - - /** - * A sub property of instrument. An object used (but not consumed) when - * performing instructions or a direction. - * - * @param HowToTool|HowToTool[]|string|string[] $tool - * - * @return static - * - * @see http://schema.org/tool - */ - public function tool($tool) - { - return $this->setProperty('tool', $tool); - } - - /** - * The total time required to perform instructions or a direction (including - * time to prepare the supplies), in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $totalTime - * - * @return static - * - * @see http://schema.org/totalTime - */ - public function totalTime($totalTime) - { - return $this->setProperty('totalTime', $totalTime); - } - - /** - * The quantity that results by performing instructions. For example, a - * paper airplane, 10 personalized candles. - * - * @param QuantitativeValue|QuantitativeValue[]|string|string[] $yield - * - * @return static - * - * @see http://schema.org/yield - */ - public function yield($yield) - { - return $this->setProperty('yield', $yield); - } - /** * The subject matter of the content. * @@ -296,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -311,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -602,6 +497,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -715,6 +641,21 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The estimated cost of the supply or supplies consumed when performing + * instructions. + * + * @param MonetaryAmount|MonetaryAmount[]|string|string[] $estimatedCost + * + * @return static + * + * @see http://schema.org/estimatedCost + */ + public function estimatedCost($estimatedCost) + { + return $this->setProperty('estimatedCost', $estimatedCost); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -827,6 +768,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1025,10 +999,26 @@ public function mainEntity($mainEntity) } /** - * A material that something is made from, e.g. leather, wool, cotton, - * paper. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Product|Product[]|string|string[] $material + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material * * @return static * @@ -1054,6 +1044,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1070,6 +1074,22 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The length of time it takes to perform instructions or a direction (not + * including time to prepare the supplies), in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $performTime + * + * @return static + * + * @see http://schema.org/performTime + */ + public function performTime($performTime) + { + return $this->setProperty('performTime', $performTime); + } + /** * The position of an item in a series or sequence of items. * @@ -1084,6 +1104,37 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * The length of time it takes to prepare the items to be used in + * instructions or a direction, in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $prepTime + * + * @return static + * + * @see http://schema.org/prepTime + */ + public function prepTime($prepTime) + { + return $this->setProperty('prepTime', $prepTime); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1225,6 +1276,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1307,6 +1374,65 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A single step item (as HowToStep, text, document, video, etc.) or a + * HowToSection. + * + * @param CreativeWork|CreativeWork[]|HowToSection|HowToSection[]|HowToStep|HowToStep[]|string|string[] $step + * + * @return static + * + * @see http://schema.org/step + */ + public function step($step) + { + return $this->setProperty('step', $step); + } + + /** + * A single step item (as HowToStep, text, document, video, etc.) or a + * HowToSection (originally misnamed 'steps'; 'step' is preferred). + * + * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $steps + * + * @return static + * + * @see http://schema.org/steps + */ + public function steps($steps) + { + return $this->setProperty('steps', $steps); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * A sub-property of instrument. A supply consumed when performing + * instructions or a direction. + * + * @param HowToSupply|HowToSupply[]|string|string[] $supply + * + * @return static + * + * @see http://schema.org/supply + */ + public function supply($supply) + { + return $this->setProperty('supply', $supply); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1398,6 +1524,37 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * A sub property of instrument. An object used (but not consumed) when + * performing instructions or a direction. + * + * @param HowToTool|HowToTool[]|string|string[] $tool + * + * @return static + * + * @see http://schema.org/tool + */ + public function tool($tool) + { + return $this->setProperty('tool', $tool); + } + + /** + * The total time required to perform instructions or a direction (including + * time to prepare the supplies), in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $totalTime + * + * @return static + * + * @see http://schema.org/totalTime + */ + public function totalTime($totalTime) + { + return $this->setProperty('totalTime', $totalTime); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1428,6 +1585,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1472,189 +1643,18 @@ public function workExample($workExample) } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. + * The quantity that results by performing instructions. For example, a + * paper airplane, 10 personalized candles. * - * @param string|string[] $url + * @param QuantitativeValue|QuantitativeValue[]|string|string[] $yield * * @return static * - * @see http://schema.org/url + * @see http://schema.org/yield */ - public function url($url) + public function yield($yield) { - return $this->setProperty('url', $url); + return $this->setProperty('yield', $yield); } } diff --git a/src/HowToDirection.php b/src/HowToDirection.php index 313de26d8..fe5854fd4 100644 --- a/src/HowToDirection.php +++ b/src/HowToDirection.php @@ -15,372 +15,6 @@ */ class HowToDirection extends BaseType implements ListItemContract, CreativeWorkContract, ThingContract { - /** - * A media object representing the circumstances after performing this - * direction. - * - * @param MediaObject|MediaObject[]|string|string[] $afterMedia - * - * @return static - * - * @see http://schema.org/afterMedia - */ - public function afterMedia($afterMedia) - { - return $this->setProperty('afterMedia', $afterMedia); - } - - /** - * A media object representing the circumstances before performing this - * direction. - * - * @param MediaObject|MediaObject[]|string|string[] $beforeMedia - * - * @return static - * - * @see http://schema.org/beforeMedia - */ - public function beforeMedia($beforeMedia) - { - return $this->setProperty('beforeMedia', $beforeMedia); - } - - /** - * A media object representing the circumstances while performing this - * direction. - * - * @param MediaObject|MediaObject[]|string|string[] $duringMedia - * - * @return static - * - * @see http://schema.org/duringMedia - */ - public function duringMedia($duringMedia) - { - return $this->setProperty('duringMedia', $duringMedia); - } - - /** - * The length of time it takes to perform instructions or a direction (not - * including time to prepare the supplies), in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $performTime - * - * @return static - * - * @see http://schema.org/performTime - */ - public function performTime($performTime) - { - return $this->setProperty('performTime', $performTime); - } - - /** - * The length of time it takes to prepare the items to be used in - * instructions or a direction, in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $prepTime - * - * @return static - * - * @see http://schema.org/prepTime - */ - public function prepTime($prepTime) - { - return $this->setProperty('prepTime', $prepTime); - } - - /** - * A sub-property of instrument. A supply consumed when performing - * instructions or a direction. - * - * @param HowToSupply|HowToSupply[]|string|string[] $supply - * - * @return static - * - * @see http://schema.org/supply - */ - public function supply($supply) - { - return $this->setProperty('supply', $supply); - } - - /** - * A sub property of instrument. An object used (but not consumed) when - * performing instructions or a direction. - * - * @param HowToTool|HowToTool[]|string|string[] $tool - * - * @return static - * - * @see http://schema.org/tool - */ - public function tool($tool) - { - return $this->setProperty('tool', $tool); - } - - /** - * The total time required to perform instructions or a direction (including - * time to prepare the supplies), in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $totalTime - * - * @return static - * - * @see http://schema.org/totalTime - */ - public function totalTime($totalTime) - { - return $this->setProperty('totalTime', $totalTime); - } - - /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. - * - * @param Thing|Thing[] $item - * - * @return static - * - * @see http://schema.org/item - */ - public function item($item) - { - return $this->setProperty('item', $item); - } - - /** - * A link to the ListItem that follows the current one. - * - * @param ListItem|ListItem[] $nextItem - * - * @return static - * - * @see http://schema.org/nextItem - */ - public function nextItem($nextItem) - { - return $this->setProperty('nextItem', $nextItem); - } - - /** - * The position of an item in a series or sequence of items. - * - * @param int|int[]|string|string[] $position - * - * @return static - * - * @see http://schema.org/position - */ - public function position($position) - { - return $this->setProperty('position', $position); - } - - /** - * A link to the ListItem that preceeds the current one. - * - * @param ListItem|ListItem[] $previousItem - * - * @return static - * - * @see http://schema.org/previousItem - */ - public function previousItem($previousItem) - { - return $this->setProperty('previousItem', $previousItem); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - /** * The subject matter of the content. * @@ -525,6 +159,40 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * A media object representing the circumstances after performing this + * direction. + * + * @param MediaObject|MediaObject[]|string|string[] $afterMedia + * + * @return static + * + * @see http://schema.org/afterMedia + */ + public function afterMedia($afterMedia) + { + return $this->setProperty('afterMedia', $afterMedia); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -540,6 +208,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -641,6 +323,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A media object representing the circumstances before performing this + * direction. + * + * @param MediaObject|MediaObject[]|string|string[] $beforeMedia + * + * @return static + * + * @see http://schema.org/beforeMedia + */ + public function beforeMedia($beforeMedia) + { + return $this->setProperty('beforeMedia', $beforeMedia); + } + /** * Fictional person connected with a creative work. * @@ -831,6 +528,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -845,6 +573,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * A media object representing the circumstances while performing this + * direction. + * + * @param MediaObject|MediaObject[]|string|string[] $duringMedia + * + * @return static + * + * @see http://schema.org/duringMedia + */ + public function duringMedia($duringMedia) + { + return $this->setProperty('duringMedia', $duringMedia); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -1020,40 +763,73 @@ public function funder($funder) * * @return static * - * @see http://schema.org/genre + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + + /** + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). + * + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline */ - public function genre($genre) + public function headline($headline) { - return $this->setProperty('genre', $genre); + return $this->setProperty('headline', $headline); } /** - * Indicates an item or CreativeWork that is part of this item, or - * CreativeWork (in some sense). + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param CreativeWork|CreativeWork[] $hasPart + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/hasPart + * @see http://schema.org/identifier */ - public function hasPart($hasPart) + public function identifier($identifier) { - return $this->setProperty('hasPart', $hasPart); + return $this->setProperty('identifier', $identifier); } /** - * Headline of the article. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $headline + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/headline + * @see http://schema.org/image */ - public function headline($headline) + public function image($image) { - return $this->setProperty('headline', $headline); + return $this->setProperty('image', $image); } /** @@ -1178,6 +954,21 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1253,6 +1044,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1283,6 +1090,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1299,6 +1134,81 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The length of time it takes to perform instructions or a direction (not + * including time to prepare the supplies), in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $performTime + * + * @return static + * + * @see http://schema.org/performTime + */ + public function performTime($performTime) + { + return $this->setProperty('performTime', $performTime); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * The length of time it takes to prepare the items to be used in + * instructions or a direction, in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $prepTime + * + * @return static + * + * @see http://schema.org/prepTime + */ + public function prepTime($prepTime) + { + return $this->setProperty('prepTime', $prepTime); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1440,6 +1350,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1522,6 +1448,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * A sub-property of instrument. A supply consumed when performing + * instructions or a direction. + * + * @param HowToSupply|HowToSupply[]|string|string[] $supply + * + * @return static + * + * @see http://schema.org/supply + */ + public function supply($supply) + { + return $this->setProperty('supply', $supply); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1613,6 +1568,37 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * A sub property of instrument. An object used (but not consumed) when + * performing instructions or a direction. + * + * @param HowToTool|HowToTool[]|string|string[] $tool + * + * @return static + * + * @see http://schema.org/tool + */ + public function tool($tool) + { + return $this->setProperty('tool', $tool); + } + + /** + * The total time required to perform instructions or a direction (including + * time to prepare the supplies), in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $totalTime + * + * @return static + * + * @see http://schema.org/totalTime + */ + public function totalTime($totalTime) + { + return $this->setProperty('totalTime', $totalTime); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1643,6 +1629,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * diff --git a/src/HowToItem.php b/src/HowToItem.php index eb7bb0df5..079f25f0a 100644 --- a/src/HowToItem.php +++ b/src/HowToItem.php @@ -15,77 +15,6 @@ */ class HowToItem extends BaseType implements ListItemContract, IntangibleContract, ThingContract { - /** - * The required quantity of the item(s). - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[]|string|string[] $requiredQuantity - * - * @return static - * - * @see http://schema.org/requiredQuantity - */ - public function requiredQuantity($requiredQuantity) - { - return $this->setProperty('requiredQuantity', $requiredQuantity); - } - - /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. - * - * @param Thing|Thing[] $item - * - * @return static - * - * @see http://schema.org/item - */ - public function item($item) - { - return $this->setProperty('item', $item); - } - - /** - * A link to the ListItem that follows the current one. - * - * @param ListItem|ListItem[] $nextItem - * - * @return static - * - * @see http://schema.org/nextItem - */ - public function nextItem($nextItem) - { - return $this->setProperty('nextItem', $nextItem); - } - - /** - * The position of an item in a series or sequence of items. - * - * @param int|int[]|string|string[] $position - * - * @return static - * - * @see http://schema.org/position - */ - public function position($position) - { - return $this->setProperty('position', $position); - } - - /** - * A link to the ListItem that preceeds the current one. - * - * @param ListItem|ListItem[] $previousItem - * - * @return static - * - * @see http://schema.org/previousItem - */ - public function previousItem($previousItem) - { - return $this->setProperty('previousItem', $previousItem); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -183,6 +112,21 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -213,6 +157,34 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -228,6 +200,34 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * The required quantity of the item(s). + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[]|string|string[] $requiredQuantity + * + * @return static + * + * @see http://schema.org/requiredQuantity + */ + public function requiredQuantity($requiredQuantity) + { + return $this->setProperty('requiredQuantity', $requiredQuantity); + } + /** * 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 diff --git a/src/HowToSection.php b/src/HowToSection.php index 3cf40d781..952fdd43f 100644 --- a/src/HowToSection.php +++ b/src/HowToSection.php @@ -16,319 +16,6 @@ */ class HowToSection extends BaseType implements ItemListContract, ListItemContract, CreativeWorkContract, ThingContract { - /** - * A single step item (as HowToStep, text, document, video, etc.) or a - * HowToSection (originally misnamed 'steps'; 'step' is preferred). - * - * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $steps - * - * @return static - * - * @see http://schema.org/steps - */ - public function steps($steps) - { - return $this->setProperty('steps', $steps); - } - - /** - * For itemListElement values, you can use simple strings (e.g. "Peter", - * "Paul", "Mary"), existing entities, or use ListItem. - * - * Text values are best if the elements in the list are plain strings. - * Existing entities are best for a simple, unordered list of existing - * things in your data. ListItem is used with ordered lists when you want to - * provide additional context about the element in that list or when the - * same item might be in different places in different lists. - * - * Note: The order of elements in your mark-up is not sufficient for - * indicating the order or elements. Use ListItem with a 'position' - * property in such cases. - * - * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement - * - * @return static - * - * @see http://schema.org/itemListElement - */ - public function itemListElement($itemListElement) - { - return $this->setProperty('itemListElement', $itemListElement); - } - - /** - * Type of ordering (e.g. Ascending, Descending, Unordered). - * - * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder - * - * @return static - * - * @see http://schema.org/itemListOrder - */ - public function itemListOrder($itemListOrder) - { - return $this->setProperty('itemListOrder', $itemListOrder); - } - - /** - * The number of items in an ItemList. Note that some descriptions might not - * fully describe all items in a list (e.g., multi-page pagination); in such - * cases, the numberOfItems would be for the entire list. - * - * @param int|int[] $numberOfItems - * - * @return static - * - * @see http://schema.org/numberOfItems - */ - public function numberOfItems($numberOfItems) - { - return $this->setProperty('numberOfItems', $numberOfItems); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. - * - * @param Thing|Thing[] $item - * - * @return static - * - * @see http://schema.org/item - */ - public function item($item) - { - return $this->setProperty('item', $item); - } - - /** - * A link to the ListItem that follows the current one. - * - * @param ListItem|ListItem[] $nextItem - * - * @return static - * - * @see http://schema.org/nextItem - */ - public function nextItem($nextItem) - { - return $this->setProperty('nextItem', $nextItem); - } - - /** - * The position of an item in a series or sequence of items. - * - * @param int|int[]|string|string[] $position - * - * @return static - * - * @see http://schema.org/position - */ - public function position($position) - { - return $this->setProperty('position', $position); - } - - /** - * A link to the ListItem that preceeds the current one. - * - * @param ListItem|ListItem[] $previousItem - * - * @return static - * - * @see http://schema.org/previousItem - */ - public function previousItem($previousItem) - { - return $this->setProperty('previousItem', $previousItem); - } - /** * The subject matter of the content. * @@ -473,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -488,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -772,11 +492,42 @@ public function dateModified($dateModified) * * @return static * - * @see http://schema.org/datePublished + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription */ - public function datePublished($datePublished) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('datePublished', $datePublished); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -1004,6 +755,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1126,6 +910,60 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1201,6 +1039,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1231,6 +1085,50 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1247,6 +1145,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1388,6 +1329,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1470,6 +1427,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A single step item (as HowToStep, text, document, video, etc.) or a + * HowToSection (originally misnamed 'steps'; 'step' is preferred). + * + * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $steps + * + * @return static + * + * @see http://schema.org/steps + */ + public function steps($steps) + { + return $this->setProperty('steps', $steps); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1591,6 +1577,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * diff --git a/src/HowToStep.php b/src/HowToStep.php index 40bc4cd91..e0a0f2094 100644 --- a/src/HowToStep.php +++ b/src/HowToStep.php @@ -16,304 +16,6 @@ */ class HowToStep extends BaseType implements ListItemContract, ItemListContract, CreativeWorkContract, ThingContract { - /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. - * - * @param Thing|Thing[] $item - * - * @return static - * - * @see http://schema.org/item - */ - public function item($item) - { - return $this->setProperty('item', $item); - } - - /** - * A link to the ListItem that follows the current one. - * - * @param ListItem|ListItem[] $nextItem - * - * @return static - * - * @see http://schema.org/nextItem - */ - public function nextItem($nextItem) - { - return $this->setProperty('nextItem', $nextItem); - } - - /** - * The position of an item in a series or sequence of items. - * - * @param int|int[]|string|string[] $position - * - * @return static - * - * @see http://schema.org/position - */ - public function position($position) - { - return $this->setProperty('position', $position); - } - - /** - * A link to the ListItem that preceeds the current one. - * - * @param ListItem|ListItem[] $previousItem - * - * @return static - * - * @see http://schema.org/previousItem - */ - public function previousItem($previousItem) - { - return $this->setProperty('previousItem', $previousItem); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * For itemListElement values, you can use simple strings (e.g. "Peter", - * "Paul", "Mary"), existing entities, or use ListItem. - * - * Text values are best if the elements in the list are plain strings. - * Existing entities are best for a simple, unordered list of existing - * things in your data. ListItem is used with ordered lists when you want to - * provide additional context about the element in that list or when the - * same item might be in different places in different lists. - * - * Note: The order of elements in your mark-up is not sufficient for - * indicating the order or elements. Use ListItem with a 'position' - * property in such cases. - * - * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement - * - * @return static - * - * @see http://schema.org/itemListElement - */ - public function itemListElement($itemListElement) - { - return $this->setProperty('itemListElement', $itemListElement); - } - - /** - * Type of ordering (e.g. Ascending, Descending, Unordered). - * - * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder - * - * @return static - * - * @see http://schema.org/itemListOrder - */ - public function itemListOrder($itemListOrder) - { - return $this->setProperty('itemListOrder', $itemListOrder); - } - - /** - * The number of items in an ItemList. Note that some descriptions might not - * fully describe all items in a list (e.g., multi-page pagination); in such - * cases, the numberOfItems would be for the entire list. - * - * @param int|int[] $numberOfItems - * - * @return static - * - * @see http://schema.org/numberOfItems - */ - public function numberOfItems($numberOfItems) - { - return $this->setProperty('numberOfItems', $numberOfItems); - } - /** * The subject matter of the content. * @@ -458,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -473,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -739,29 +474,60 @@ public function dateCreated($dateCreated) * The date on which the CreativeWork was most recently modified or when the * item's entry was modified within a DataFeed. * - * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A description of the item. + * + * @param string|string[] $description * * @return static * - * @see http://schema.org/dateModified + * @see http://schema.org/description */ - public function dateModified($dateModified) + public function description($description) { - return $this->setProperty('dateModified', $dateModified); + return $this->setProperty('description', $description); } /** - * Date of first broadcast/publication. + * 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. * - * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/datePublished + * @see http://schema.org/disambiguatingDescription */ - public function datePublished($datePublished) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('datePublished', $datePublished); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -989,6 +755,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1111,6 +910,60 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1186,6 +1039,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1216,6 +1085,50 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1232,6 +1145,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1373,6 +1329,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1455,6 +1427,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1576,6 +1562,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * diff --git a/src/HowToSupply.php b/src/HowToSupply.php index b1bb25ec7..5c4b403ec 100644 --- a/src/HowToSupply.php +++ b/src/HowToSupply.php @@ -16,92 +16,6 @@ */ class HowToSupply extends BaseType implements HowToItemContract, ListItemContract, IntangibleContract, ThingContract { - /** - * The estimated cost of the supply or supplies consumed when performing - * instructions. - * - * @param MonetaryAmount|MonetaryAmount[]|string|string[] $estimatedCost - * - * @return static - * - * @see http://schema.org/estimatedCost - */ - public function estimatedCost($estimatedCost) - { - return $this->setProperty('estimatedCost', $estimatedCost); - } - - /** - * The required quantity of the item(s). - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[]|string|string[] $requiredQuantity - * - * @return static - * - * @see http://schema.org/requiredQuantity - */ - public function requiredQuantity($requiredQuantity) - { - return $this->setProperty('requiredQuantity', $requiredQuantity); - } - - /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. - * - * @param Thing|Thing[] $item - * - * @return static - * - * @see http://schema.org/item - */ - public function item($item) - { - return $this->setProperty('item', $item); - } - - /** - * A link to the ListItem that follows the current one. - * - * @param ListItem|ListItem[] $nextItem - * - * @return static - * - * @see http://schema.org/nextItem - */ - public function nextItem($nextItem) - { - return $this->setProperty('nextItem', $nextItem); - } - - /** - * The position of an item in a series or sequence of items. - * - * @param int|int[]|string|string[] $position - * - * @return static - * - * @see http://schema.org/position - */ - public function position($position) - { - return $this->setProperty('position', $position); - } - - /** - * A link to the ListItem that preceeds the current one. - * - * @param ListItem|ListItem[] $previousItem - * - * @return static - * - * @see http://schema.org/previousItem - */ - public function previousItem($previousItem) - { - return $this->setProperty('previousItem', $previousItem); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -166,6 +80,21 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The estimated cost of the supply or supplies consumed when performing + * instructions. + * + * @param MonetaryAmount|MonetaryAmount[]|string|string[] $estimatedCost + * + * @return static + * + * @see http://schema.org/estimatedCost + */ + public function estimatedCost($estimatedCost) + { + return $this->setProperty('estimatedCost', $estimatedCost); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -199,6 +128,21 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -229,6 +173,34 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -244,6 +216,34 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * The required quantity of the item(s). + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[]|string|string[] $requiredQuantity + * + * @return static + * + * @see http://schema.org/requiredQuantity + */ + public function requiredQuantity($requiredQuantity) + { + return $this->setProperty('requiredQuantity', $requiredQuantity); + } + /** * 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 diff --git a/src/HowToTip.php b/src/HowToTip.php index aad7f3b20..bc1d9c244 100644 --- a/src/HowToTip.php +++ b/src/HowToTip.php @@ -17,249 +17,6 @@ */ class HowToTip extends BaseType implements ListItemContract, CreativeWorkContract, ThingContract { - /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. - * - * @param Thing|Thing[] $item - * - * @return static - * - * @see http://schema.org/item - */ - public function item($item) - { - return $this->setProperty('item', $item); - } - - /** - * A link to the ListItem that follows the current one. - * - * @param ListItem|ListItem[] $nextItem - * - * @return static - * - * @see http://schema.org/nextItem - */ - public function nextItem($nextItem) - { - return $this->setProperty('nextItem', $nextItem); - } - - /** - * The position of an item in a series or sequence of items. - * - * @param int|int[]|string|string[] $position - * - * @return static - * - * @see http://schema.org/position - */ - public function position($position) - { - return $this->setProperty('position', $position); - } - - /** - * A link to the ListItem that preceeds the current one. - * - * @param ListItem|ListItem[] $previousItem - * - * @return static - * - * @see http://schema.org/previousItem - */ - public function previousItem($previousItem) - { - return $this->setProperty('previousItem', $previousItem); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - /** * The subject matter of the content. * @@ -404,6 +161,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -419,6 +195,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -710,6 +500,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -935,6 +756,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1057,6 +911,21 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1132,6 +1001,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1162,6 +1047,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1178,6 +1091,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1319,6 +1275,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1401,6 +1373,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1522,6 +1508,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * diff --git a/src/HowToTool.php b/src/HowToTool.php index 7b18a7111..3c5654b4d 100644 --- a/src/HowToTool.php +++ b/src/HowToTool.php @@ -16,77 +16,6 @@ */ class HowToTool extends BaseType implements HowToItemContract, ListItemContract, IntangibleContract, ThingContract { - /** - * The required quantity of the item(s). - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[]|string|string[] $requiredQuantity - * - * @return static - * - * @see http://schema.org/requiredQuantity - */ - public function requiredQuantity($requiredQuantity) - { - return $this->setProperty('requiredQuantity', $requiredQuantity); - } - - /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. - * - * @param Thing|Thing[] $item - * - * @return static - * - * @see http://schema.org/item - */ - public function item($item) - { - return $this->setProperty('item', $item); - } - - /** - * A link to the ListItem that follows the current one. - * - * @param ListItem|ListItem[] $nextItem - * - * @return static - * - * @see http://schema.org/nextItem - */ - public function nextItem($nextItem) - { - return $this->setProperty('nextItem', $nextItem); - } - - /** - * The position of an item in a series or sequence of items. - * - * @param int|int[]|string|string[] $position - * - * @return static - * - * @see http://schema.org/position - */ - public function position($position) - { - return $this->setProperty('position', $position); - } - - /** - * A link to the ListItem that preceeds the current one. - * - * @param ListItem|ListItem[] $previousItem - * - * @return static - * - * @see http://schema.org/previousItem - */ - public function previousItem($previousItem) - { - return $this->setProperty('previousItem', $previousItem); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -184,6 +113,21 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -214,6 +158,34 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -229,6 +201,34 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + + /** + * The required quantity of the item(s). + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[]|string|string[] $requiredQuantity + * + * @return static + * + * @see http://schema.org/requiredQuantity + */ + public function requiredQuantity($requiredQuantity) + { + return $this->setProperty('requiredQuantity', $requiredQuantity); + } + /** * 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 diff --git a/src/IceCreamShop.php b/src/IceCreamShop.php index 2998f2606..cc3fcd04f 100644 --- a/src/IceCreamShop.php +++ b/src/IceCreamShop.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/IgnoreAction.php b/src/IgnoreAction.php index 27af8d4cd..ed7b93a9a 100644 --- a/src/IgnoreAction.php +++ b/src/IgnoreAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ImageGallery.php b/src/ImageGallery.php index 8887df8ba..93d92e03c 100644 --- a/src/ImageGallery.php +++ b/src/ImageGallery.php @@ -15,176 +15,6 @@ */ class ImageGallery extends BaseType implements CollectionPageContract, WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -329,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -344,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -445,6 +308,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -635,6 +513,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -861,13 +770,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -997,6 +939,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1042,6 +999,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1057,6 +1028,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1087,6 +1074,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1117,6 +1118,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1215,6 +1245,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1244,6 +1288,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1258,6 +1317,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1275,6 +1350,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1324,6 +1429,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1340,6 +1498,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1461,6 +1633,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1504,190 +1690,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ImageObject.php b/src/ImageObject.php index 816fe6a73..fd82bb331 100644 --- a/src/ImageObject.php +++ b/src/ImageObject.php @@ -14,343 +14,6 @@ */ class ImageObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { - /** - * The caption for this object. For downloadable machine formats (closed - * caption, subtitles etc.) use MediaObject and indicate the - * [[encodingFormat]]. - * - * @param MediaObject|MediaObject[]|string|string[] $caption - * - * @return static - * - * @see http://schema.org/caption - */ - public function caption($caption) - { - return $this->setProperty('caption', $caption); - } - - /** - * exif data for this object. - * - * @param PropertyValue|PropertyValue[]|string|string[] $exifData - * - * @return static - * - * @see http://schema.org/exifData - */ - public function exifData($exifData) - { - return $this->setProperty('exifData', $exifData); - } - - /** - * Indicates whether this image is representative of the content of the - * page. - * - * @param bool|bool[] $representativeOfPage - * - * @return static - * - * @see http://schema.org/representativeOfPage - */ - public function representativeOfPage($representativeOfPage) - { - return $this->setProperty('representativeOfPage', $representativeOfPage); - } - - /** - * Thumbnail image for an image or video. - * - * @param ImageObject|ImageObject[] $thumbnail - * - * @return static - * - * @see http://schema.org/thumbnail - */ - public function thumbnail($thumbnail) - { - return $this->setProperty('thumbnail', $thumbnail); - } - - /** - * A NewsArticle associated with the Media Object. - * - * @param NewsArticle|NewsArticle[] $associatedArticle - * - * @return static - * - * @see http://schema.org/associatedArticle - */ - public function associatedArticle($associatedArticle) - { - return $this->setProperty('associatedArticle', $associatedArticle); - } - - /** - * The bitrate of the media object. - * - * @param string|string[] $bitrate - * - * @return static - * - * @see http://schema.org/bitrate - */ - public function bitrate($bitrate) - { - return $this->setProperty('bitrate', $bitrate); - } - - /** - * File size in (mega/kilo) bytes. - * - * @param string|string[] $contentSize - * - * @return static - * - * @see http://schema.org/contentSize - */ - public function contentSize($contentSize) - { - return $this->setProperty('contentSize', $contentSize); - } - - /** - * Actual bytes of the media object, for example the image file or video - * file. - * - * @param string|string[] $contentUrl - * - * @return static - * - * @see http://schema.org/contentUrl - */ - public function contentUrl($contentUrl) - { - return $this->setProperty('contentUrl', $contentUrl); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * A URL pointing to a player for a specific video. In general, this is the - * information in the ```src``` element of an ```embed``` tag and should not - * be the same as the content of the ```loc``` tag. - * - * @param string|string[] $embedUrl - * - * @return static - * - * @see http://schema.org/embedUrl - */ - public function embedUrl($embedUrl) - { - return $this->setProperty('embedUrl', $embedUrl); - } - - /** - * The CreativeWork encoded by this media object. - * - * @param CreativeWork|CreativeWork[] $encodesCreativeWork - * - * @return static - * - * @see http://schema.org/encodesCreativeWork - */ - public function encodesCreativeWork($encodesCreativeWork) - { - return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); - } - - /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside - * particular [[encodingFormat]] information. - * - * Unregistered or niche encoding and file formats can be indicated instead - * via the most appropriate URL, e.g. defining Web page or a - * Wikipedia/Wikidata entry. - * - * @param string|string[] $encodingFormat - * - * @return static - * - * @see http://schema.org/encodingFormat - */ - public function encodingFormat($encodingFormat) - { - return $this->setProperty('encodingFormat', $encodingFormat); - } - - /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime - * - * @return static - * - * @see http://schema.org/endTime - */ - public function endTime($endTime) - { - return $this->setProperty('endTime', $endTime); - } - - /** - * The height of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height - * - * @return static - * - * @see http://schema.org/height - */ - public function height($height) - { - return $this->setProperty('height', $height); - } - - /** - * Player type required—for example, Flash or Silverlight. - * - * @param string|string[] $playerType - * - * @return static - * - * @see http://schema.org/playerType - */ - public function playerType($playerType) - { - return $this->setProperty('playerType', $playerType); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The regions where the media is allowed. If not specified, then it's - * assumed to be allowed everywhere. Specify the countries in [ISO 3166 - * format](http://en.wikipedia.org/wiki/ISO_3166). - * - * @param Place|Place[] $regionsAllowed - * - * @return static - * - * @see http://schema.org/regionsAllowed - */ - public function regionsAllowed($regionsAllowed) - { - return $this->setProperty('regionsAllowed', $regionsAllowed); - } - - /** - * Indicates if use of the media require a subscription (either paid or - * free). Allowed values are ```true``` or ```false``` (note that an earlier - * version had 'yes', 'no'). - * - * @param bool|bool[] $requiresSubscription - * - * @return static - * - * @see http://schema.org/requiresSubscription - */ - public function requiresSubscription($requiresSubscription) - { - return $this->setProperty('requiresSubscription', $requiresSubscription); - } - - /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime - * - * @return static - * - * @see http://schema.org/startTime - */ - public function startTime($startTime) - { - return $this->setProperty('startTime', $startTime); - } - - /** - * Date when this media object was uploaded to this site. - * - * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate - * - * @return static - * - * @see http://schema.org/uploadDate - */ - public function uploadDate($uploadDate) - { - return $this->setProperty('uploadDate', $uploadDate); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - /** * The subject matter of the content. * @@ -495,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -510,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -524,6 +220,20 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -611,6 +321,36 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * The caption for this object. For downloadable machine formats (closed + * caption, subtitles etc.) use MediaObject and indicate the + * [[encodingFormat]]. + * + * @param MediaObject|MediaObject[]|string|string[] $caption + * + * @return static + * + * @see http://schema.org/caption + */ + public function caption($caption) + { + return $this->setProperty('caption', $caption); + } + /** * Fictional person connected with a creative work. * @@ -699,6 +439,35 @@ public function contentRating($contentRating) return $this->setProperty('contentRating', $contentRating); } + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + /** * A secondary contributor to the CreativeWork or Event. * @@ -801,6 +570,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -815,6 +615,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -858,6 +673,36 @@ public function educationalUse($educationalUse) return $this->setProperty('educationalUse', $educationalUse); } + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for associatedMedia. @@ -873,6 +718,33 @@ public function encoding($encoding) return $this->setProperty('encoding', $encoding); } + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + /** * A media object that encodes this CreativeWork. * @@ -887,6 +759,29 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -902,6 +797,20 @@ public function exampleOfWork($exampleOfWork) return $this->setProperty('exampleOfWork', $exampleOfWork); } + /** + * exif data for this object. + * + * @param PropertyValue|PropertyValue[]|string|string[] $exifData + * + * @return static + * + * @see http://schema.org/exifData + */ + public function exifData($exifData) + { + return $this->setProperty('exifData', $exifData); + } + /** * Date the content expires and is no longer useful or available. For * example a [[VideoObject]] or [[NewsArticle]] whose availability or @@ -999,6 +908,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1196,6 +1152,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1226,6 +1198,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1242,6 +1228,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + /** * The position of an item in a series or sequence of items. * @@ -1256,6 +1256,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1271,6 +1286,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1354,6 +1384,22 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1369,6 +1415,37 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Indicates whether this image is representative of the content of the + * page. + * + * @param bool|bool[] $representativeOfPage + * + * @return static + * + * @see http://schema.org/representativeOfPage + */ + public function representativeOfPage($representativeOfPage) + { + return $this->setProperty('representativeOfPage', $representativeOfPage); + } + + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + /** * A review of the item. * @@ -1397,6 +1474,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1445,38 +1538,75 @@ public function spatial($spatial) } /** - * The spatialCoverage of a CreativeWork indicates the place(s) which are - * the focus of the content. It is a subproperty of - * contentLocation intended primarily for more technical and detailed - * materials. For example with a Dataset, it indicates - * areas that the dataset describes: a dataset of New York weather - * would have spatialCoverage which was the place: the state of New York. + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[] $spatialCoverage + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/startTime */ - public function spatialCoverage($spatialCoverage) + public function startTime($startTime) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/subjectOf */ - public function sponsor($sponsor) + public function subjectOf($subjectOf) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('subjectOf', $subjectOf); } /** @@ -1540,6 +1670,20 @@ public function text($text) return $this->setProperty('text', $text); } + /** + * Thumbnail image for an image or video. + * + * @param ImageObject|ImageObject[] $thumbnail + * + * @return static + * + * @see http://schema.org/thumbnail + */ + public function thumbnail($thumbnail) + { + return $this->setProperty('thumbnail', $thumbnail); + } + /** * A thumbnail image relevant to the Thing. * @@ -1601,232 +1745,88 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Date when this media object was uploaded to this site. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/uploadDate */ - public function mainEntityOfPage($mainEntityOfPage) + public function uploadDate($uploadDate) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('uploadDate', $uploadDate); } /** - * The name of the item. + * URL of the item. * - * @param string|string[] $name + * @param string|string[] $url * * @return static * - * @see http://schema.org/name + * @see http://schema.org/url */ - public function name($name) + public function url($url) { - return $this->setProperty('name', $name); + return $this->setProperty('url', $url); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The version of the CreativeWork embodied by a specified resource. * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/version */ - public function potentialAction($potentialAction) + public function version($version) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('version', $version); } /** - * 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. + * An embedded video object. * - * @param string|string[] $sameAs + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/video */ - public function sameAs($sameAs) + public function video($video) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('video', $video); } /** - * A CreativeWork or Event about this Thing. + * The width of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/width */ - public function subjectOf($subjectOf) + public function width($width) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('width', $width); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/IndividualProduct.php b/src/IndividualProduct.php index 8be401b68..6b91516ab 100644 --- a/src/IndividualProduct.php +++ b/src/IndividualProduct.php @@ -14,22 +14,6 @@ */ class IndividualProduct extends BaseType implements ProductContract, ThingContract { - /** - * The serial number or any alphanumeric identifier of a particular product. - * When attached to an offer, it is a shortcut for the serial number of the - * product included in the offer. - * - * @param string|string[] $serialNumber - * - * @return static - * - * @see http://schema.org/serialNumber - */ - public function serialNumber($serialNumber) - { - return $this->setProperty('serialNumber', $serialNumber); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -52,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -67,6 +70,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An intended audience, i.e. a group for whom something was created. * @@ -167,6 +184,37 @@ public function depth($depth) return $this->setProperty('depth', $depth); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The GTIN-12 code of the product, or the product to which the offer * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a @@ -254,6 +302,39 @@ public function height($height) return $this->setProperty('height', $height); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another product (or multiple products) for which this * product is an accessory or spare part. @@ -343,6 +424,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The manufacturer of the product. * @@ -405,6 +502,20 @@ public function mpn($mpn) return $this->setProperty('mpn', $mpn); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -421,6 +532,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The product identifier, such as ISBN. For example: ``` meta * itemprop="productID" content="isbn:123-456-789" ```. @@ -508,246 +634,120 @@ public function reviews($reviews) } /** - * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a - * product or service, or the product to which the offer refers. - * - * @param string|string[] $sku - * - * @return static - * - * @see http://schema.org/sku - */ - public function sku($sku) - { - return $this->setProperty('sku', $sku); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * The weight of the product or person. - * - * @param QuantitativeValue|QuantitativeValue[] $weight - * - * @return static - * - * @see http://schema.org/weight - */ - public function weight($weight) - { - return $this->setProperty('weight', $weight); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The serial number or any alphanumeric identifier of a particular product. + * When attached to an offer, it is a shortcut for the serial number of the + * product included in the offer. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $serialNumber * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serialNumber */ - public function image($image) + public function serialNumber($serialNumber) { - return $this->setProperty('image', $image); + return $this->setProperty('serialNumber', $serialNumber); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a + * product or service, or the product to which the offer refers. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sku * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sku */ - public function mainEntityOfPage($mainEntityOfPage) + public function sku($sku) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sku', $sku); } /** - * The name of the item. + * A slogan or motto associated with the item. * - * @param string|string[] $name + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/name + * @see http://schema.org/slogan */ - public function name($name) + public function slogan($slogan) { - return $this->setProperty('name', $name); + return $this->setProperty('slogan', $slogan); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The weight of the product or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param QuantitativeValue|QuantitativeValue[] $weight * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/weight */ - public function subjectOf($subjectOf) + public function weight($weight) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('weight', $weight); } /** - * URL of the item. + * The width of the item. * - * @param string|string[] $url + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/url + * @see http://schema.org/width */ - public function url($url) + public function width($width) { - return $this->setProperty('url', $url); + return $this->setProperty('width', $width); } } diff --git a/src/InformAction.php b/src/InformAction.php index 7ef90ace0..374439f68 100644 --- a/src/InformAction.php +++ b/src/InformAction.php @@ -17,107 +17,110 @@ class InformAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** - * Upcoming or past event associated with this place, organization, or - * action. + * The subject matter of the content. * - * @param Event|Event[] $event + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/event + * @see http://schema.org/about */ - public function event($event) + public function about($about) { - return $this->setProperty('event', $event); + return $this->setProperty('about', $about); } /** - * The subject matter of the content. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $about + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/about + * @see http://schema.org/actionStatus */ - public function about($about) + public function actionStatus($actionStatus) { - return $this->setProperty('about', $about); + return $this->setProperty('actionStatus', $actionStatus); } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[]|string|string[] $inLanguage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/additionalType */ - public function inLanguage($inLanguage) + public function additionalType($additionalType) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of instrument. The language used on this action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Language|Language[] $language + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/language + * @see http://schema.org/agent */ - public function language($language) + public function agent($agent) { - return $this->setProperty('language', $language); + return $this->setProperty('agent', $agent); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * An alias for the item. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/alternateName */ - public function recipient($recipient) + public function alternateName($alternateName) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -158,288 +161,285 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param Thing|Thing[] $instrument + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/event */ - public function instrument($instrument) + public function event($event) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('event', $event); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/inLanguage */ - public function participant($participant) + public function inLanguage($inLanguage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('inLanguage', $inLanguage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of instrument. The language used on this action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/language */ - public function startTime($startTime) + public function language($language) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('language', $language); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/InsertAction.php b/src/InsertAction.php index 2f5b3008a..375ef51f1 100644 --- a/src/InsertAction.php +++ b/src/InsertAction.php @@ -16,75 +16,110 @@ class InsertAction extends BaseType implements AddActionContract, UpdateActionContract, ActionContract, ThingContract { /** - * A sub property of location. The final location of the object or the agent - * after the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $toLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/actionStatus */ - public function toLocation($toLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of object. The collection target of the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $collection + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/collection + * @see http://schema.org/additionalType */ - public function collection($collection) + public function additionalType($additionalType) { - return $this->setProperty('collection', $collection); + return $this->setProperty('additionalType', $additionalType); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); } /** * A sub property of object. The collection target of the action. * - * @param Thing|Thing[] $targetCollection + * @param Thing|Thing[] $collection * * @return static * - * @see http://schema.org/targetCollection + * @see http://schema.org/collection */ - public function targetCollection($targetCollection) + public function collection($collection) { - return $this->setProperty('targetCollection', $targetCollection); + return $this->setProperty('collection', $collection); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -125,288 +160,253 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $object + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/object + * @see http://schema.org/identifier */ - public function object($object) + public function identifier($identifier) { - return $this->setProperty('object', $object); + return $this->setProperty('identifier', $identifier); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/image */ - public function participant($participant) + public function image($image) { - return $this->setProperty('participant', $participant); + return $this->setProperty('image', $image); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/result */ - public function identifier($identifier) + public function result($result) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('result', $result); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/startTime */ - public function mainEntityOfPage($mainEntityOfPage) + public function startTime($startTime) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('startTime', $startTime); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates a target EntryPoint for an Action. * - * @param Action|Action[] $potentialAction + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/target */ - public function potentialAction($potentialAction) + public function target($target) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('target', $target); } /** - * 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. + * A sub property of object. The collection target of the action. * - * @param string|string[] $sameAs + * @param Thing|Thing[] $targetCollection * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/targetCollection */ - public function sameAs($sameAs) + public function targetCollection($targetCollection) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('targetCollection', $targetCollection); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/InstallAction.php b/src/InstallAction.php index 2f9a40677..d3da9e2d3 100644 --- a/src/InstallAction.php +++ b/src/InstallAction.php @@ -31,33 +31,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -76,325 +79,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/InsuranceAgency.php b/src/InsuranceAgency.php index 2fcee347a..088dc5ab9 100644 --- a/src/InsuranceAgency.php +++ b/src/InsuranceAgency.php @@ -17,183 +17,181 @@ class InsuranceAgency extends BaseType implements FinancialServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $feesAndCommissionsSpecification + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/additionalProperty */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function additionalProperty($additionalProperty) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/additionalType */ - public function branchOf($branchOf) + public function additionalType($additionalType) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Physical address of the item. * - * @param string|string[] $currenciesAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/address */ - public function currenciesAccepted($currenciesAccepted) + public function address($address) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('address', $address); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $openingHours + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/aggregateRating */ - public function openingHours($openingHours) + public function aggregateRating($aggregateRating) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * An alias for the item. * - * @param string|string[] $paymentAccepted + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/alternateName */ - public function paymentAccepted($paymentAccepted) + public function alternateName($alternateName) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('alternateName', $alternateName); } /** - * The price range of the business, for example ```$$$```. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $priceRange + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/amenityFeature */ - public function priceRange($priceRange) + public function amenityFeature($amenityFeature) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Physical address of the item. + * The geographic area where a service or offered item is provided. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/address + * @see http://schema.org/areaServed */ - public function address($address) + public function areaServed($areaServed) { - return $this->setProperty('address', $address); + return $this->setProperty('areaServed', $areaServed); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An award won by or for this item. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $award * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/award */ - public function aggregateRating($aggregateRating) + public function award($award) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('award', $award); } /** - * The geographic area where a service or offered item is provided. + * Awards won by or for this item. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param string|string[] $awards * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/awards */ - public function areaServed($areaServed) + public function awards($awards) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('awards', $awards); } /** - * An award won by or for this item. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param string|string[] $award + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/award + * @see http://schema.org/branchCode */ - public function award($award) + public function branchCode($branchCode) { - return $this->setProperty('award', $award); + return $this->setProperty('branchCode', $branchCode); } /** - * Awards won by or for this item. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $awards + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/branchOf */ - public function awards($awards) + public function branchOf($branchOf) { - return $this->setProperty('awards', $awards); + return $this->setProperty('branchOf', $branchOf); } /** @@ -239,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -256,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -370,6 +464,21 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + /** * A person who founded this organization. * @@ -441,6 +550,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -458,6 +581,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -487,6 +624,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -503,6 +687,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -561,6 +760,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -575,6 +805,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -634,6 +906,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -662,6 +948,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -692,664 +1021,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/photos */ - public function reviews($reviews) + public function photos($photos) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Demand|Demand[] $seeks + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/potentialAction */ - public function seeks($seeks) + public function potentialAction($potentialAction) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The geographic area where the service is provided. + * The price range of the business, for example ```$$$```. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/priceRange */ - public function serviceArea($serviceArea) + public function priceRange($priceRange) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('priceRange', $priceRange); } /** - * A slogan or motto associated with the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $slogan + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/publicAccess */ - public function slogan($slogan) + public function publicAccess($publicAccess) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/publishingPrinciples */ - public function sponsor($sponsor) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A review of the item. * - * @param Organization|Organization[] $subOrganization + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/review */ - public function subOrganization($subOrganization) + public function review($review) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('review', $review); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * Review of the item. * - * @param string|string[] $taxID + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/reviews */ - public function taxID($taxID) + public function reviews($reviews) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('reviews', $reviews); } /** - * The telephone number. + * 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. * - * @param string|string[] $telephone + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/sameAs */ - public function telephone($telephone) + public function sameAs($sameAs) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('sameAs', $sameAs); } /** - * The Value-added Tax ID of the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param string|string[] $vatID + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/seeks */ - public function vatID($vatID) + public function seeks($seeks) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('seeks', $seeks); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geographic area where the service is provided. * - * @param string|string[] $additionalType + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/serviceArea */ - public function additionalType($additionalType) + public function serviceArea($serviceArea) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('serviceArea', $serviceArea); } /** - * An alias for the item. + * A slogan or motto associated with the item. * - * @param string|string[] $alternateName + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/slogan */ - public function alternateName($alternateName) + public function slogan($slogan) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('slogan', $slogan); } /** - * A description of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $description + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/description + * @see http://schema.org/smokingAllowed */ - public function description($description) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('description', $description); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * 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. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $disambiguatingDescription + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/specialOpeningHoursSpecification */ - public function disambiguatingDescription($disambiguatingDescription) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sponsor */ - public function identifier($identifier) + public function sponsor($sponsor) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sponsor', $sponsor); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/image + * @see http://schema.org/subOrganization */ - public function image($image) + public function subOrganization($subOrganization) { - return $this->setProperty('image', $image); + return $this->setProperty('subOrganization', $subOrganization); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A CreativeWork or Event about this Thing. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/subjectOf */ - public function mainEntityOfPage($mainEntityOfPage) + public function subjectOf($subjectOf) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('subjectOf', $subjectOf); } /** - * The name of the item. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param string|string[] $name + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/name + * @see http://schema.org/taxID */ - public function name($name) + public function taxID($taxID) { - return $this->setProperty('name', $name); + return $this->setProperty('taxID', $taxID); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The telephone number. * - * @param Action|Action[] $potentialAction + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/telephone */ - public function potentialAction($potentialAction) + public function telephone($telephone) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('telephone', $telephone); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The Value-added Tax ID of the organization or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/vatID */ - public function subjectOf($subjectOf) + public function vatID($vatID) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty - * - * @return static - * - * @see http://schema.org/additionalProperty - */ - public function additionalProperty($additionalProperty) - { - return $this->setProperty('additionalProperty', $additionalProperty); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. - * - * @param string|string[] $branchCode - * - * @return static - * - * @see http://schema.org/branchCode - */ - public function branchCode($branchCode) - { - return $this->setProperty('branchCode', $branchCode); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedIn - * - * @return static - * - * @see http://schema.org/containedIn - */ - public function containedIn($containedIn) - { - return $this->setProperty('containedIn', $containedIn); - } - - /** - * The basic containment relation between a place and one that contains it. - * - * @param Place|Place[] $containedInPlace - * - * @return static - * - * @see http://schema.org/containedInPlace - */ - public function containedInPlace($containedInPlace) - { - return $this->setProperty('containedInPlace', $containedInPlace); - } - - /** - * The basic containment relation between a place and another that it - * contains. - * - * @param Place|Place[] $containsPlace - * - * @return static - * - * @see http://schema.org/containsPlace - */ - public function containsPlace($containsPlace) - { - return $this->setProperty('containsPlace', $containsPlace); - } - - /** - * The geo coordinates of the place. - * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo - * - * @return static - * - * @see http://schema.org/geo - */ - public function geo($geo) - { - return $this->setProperty('geo', $geo); - } - - /** - * A URL to a map of the place. - * - * @param Map|Map[]|string|string[] $hasMap - * - * @return static - * - * @see http://schema.org/hasMap - */ - public function hasMap($hasMap) - { - return $this->setProperty('hasMap', $hasMap); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $latitude - * - * @return static - * - * @see http://schema.org/latitude - */ - public function latitude($latitude) - { - return $this->setProperty('latitude', $latitude); - } - - /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). - * - * @param float|float[]|int|int[]|string|string[] $longitude - * - * @return static - * - * @see http://schema.org/longitude - */ - public function longitude($longitude) - { - return $this->setProperty('longitude', $longitude); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $map - * - * @return static - * - * @see http://schema.org/map - */ - public function map($map) - { - return $this->setProperty('map', $map); - } - - /** - * A URL to a map of the place. - * - * @param string|string[] $maps - * - * @return static - * - * @see http://schema.org/maps - */ - public function maps($maps) - { - return $this->setProperty('maps', $maps); - } - - /** - * The total number of individuals that may attend an event or venue. - * - * @param int|int[] $maximumAttendeeCapacity - * - * @return static - * - * @see http://schema.org/maximumAttendeeCapacity - */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) - { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); - } - - /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. - * - * @param bool|bool[] $smokingAllowed - * - * @return static - * - * @see http://schema.org/smokingAllowed - */ - public function smokingAllowed($smokingAllowed) - { - return $this->setProperty('smokingAllowed', $smokingAllowed); - } - - /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification - * - * @return static - * - * @see http://schema.org/specialOpeningHoursSpecification - */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) - { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/InteractAction.php b/src/InteractAction.php index 5e20f33a6..1bfa3984c 100644 --- a/src/InteractAction.php +++ b/src/InteractAction.php @@ -28,340 +28,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/InteractionCounter.php b/src/InteractionCounter.php index 29b65131a..1c5481924 100644 --- a/src/InteractionCounter.php +++ b/src/InteractionCounter.php @@ -15,22 +15,6 @@ */ class InteractionCounter extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { - /** - * The Action representing the type of interaction. For up votes, +1s, etc. - * use [[LikeAction]]. For down votes use [[DislikeAction]]. Otherwise, use - * the most specific Action. - * - * @param Action|Action[] $interactionType - * - * @return static - * - * @see http://schema.org/interactionType - */ - public function interactionType($interactionType) - { - return $this->setProperty('interactionType', $interactionType); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -128,6 +112,22 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The Action representing the type of interaction. For up votes, +1s, etc. + * use [[LikeAction]]. For down votes use [[DislikeAction]]. Otherwise, use + * the most specific Action. + * + * @param Action|Action[] $interactionType + * + * @return static + * + * @see http://schema.org/interactionType + */ + public function interactionType($interactionType) + { + return $this->setProperty('interactionType', $interactionType); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background diff --git a/src/InternetCafe.php b/src/InternetCafe.php index c0eddae6e..132cf252f 100644 --- a/src/InternetCafe.php +++ b/src/InternetCafe.php @@ -16,126 +16,104 @@ class InternetCafe extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/InvestmentOrDeposit.php b/src/InvestmentOrDeposit.php index 98d3eac42..22d87875b 100644 --- a/src/InvestmentOrDeposit.php +++ b/src/InvestmentOrDeposit.php @@ -18,79 +18,82 @@ class InvestmentOrDeposit extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** - * The amount of money. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/amount + * @see http://schema.org/additionalType */ - public function amount($amount) + public function additionalType($additionalType) { - return $this->setProperty('amount', $amount); + return $this->setProperty('additionalType', $additionalType); } /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/aggregateRating */ - public function annualPercentageRate($annualPercentageRate) + public function aggregateRating($aggregateRating) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * An alias for the item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/alternateName */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function alternateName($alternateName) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('alternateName', $alternateName); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * The amount of money. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/amount */ - public function interestRate($interestRate) + public function amount($amount) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('amount', $amount); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/annualPercentageRate */ - public function aggregateRating($aggregateRating) + public function annualPercentageRate($annualPercentageRate) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -198,380 +201,377 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * A description of the item. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/description */ - public function hasOfferCatalog($hasOfferCatalog) + public function description($description) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('description', $description); } /** - * The hours during which this service or contact is available. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/disambiguatingDescription */ - public function hoursAvailable($hoursAvailable) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, somehow related product (or multiple products). + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param string|string[] $feesAndCommissionsSpecification * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/feesAndCommissionsSpecification */ - public function isRelatedTo($isRelatedTo) + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/hasOfferCatalog */ - public function isSimilarTo($isSimilarTo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An associated logo. + * The hours during which this service or contact is available. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hoursAvailable */ - public function logo($logo) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $offers + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/identifier */ - public function offers($offers) + public function identifier($identifier) { - return $this->setProperty('offers', $offers); + return $this->setProperty('identifier', $identifier); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $produces + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/image */ - public function produces($produces) + public function image($image) { - return $this->setProperty('produces', $produces); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/interestRate */ - public function provider($provider) + public function interestRate($interestRate) { - return $this->setProperty('provider', $provider); + return $this->setProperty('interestRate', $interestRate); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * A pointer to another, somehow related product (or multiple products). * - * @param string|string[] $providerMobility + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/isRelatedTo */ - public function providerMobility($providerMobility) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * A review of the item. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param Review|Review[] $review + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/isSimilarTo */ - public function review($review) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('review', $review); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * The geographic area where the service is provided. + * An associated logo. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/logo */ - public function serviceArea($serviceArea) + public function logo($logo) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('logo', $logo); } /** - * The audience eligible for this service. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Audience|Audience[] $serviceAudience + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/mainEntityOfPage */ - public function serviceAudience($serviceAudience) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * The name of the item. * - * @param Thing|Thing[] $serviceOutput + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/name */ - public function serviceOutput($serviceOutput) + public function name($name) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('name', $name); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param string|string[] $serviceType + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/offers */ - public function serviceType($serviceType) + public function offers($offers) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('offers', $offers); } /** - * A slogan or motto associated with the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $slogan + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/potentialAction */ - public function slogan($slogan) + public function potentialAction($potentialAction) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/produces */ - public function additionalType($additionalType) + public function produces($produces) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('produces', $produces); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $description + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/description + * @see http://schema.org/providerMobility */ - public function description($description) + public function providerMobility($providerMobility) { - return $this->setProperty('description', $description); + return $this->setProperty('providerMobility', $providerMobility); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** diff --git a/src/InviteAction.php b/src/InviteAction.php index b72be363d..2022fffa6 100644 --- a/src/InviteAction.php +++ b/src/InviteAction.php @@ -16,107 +16,110 @@ class InviteAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** - * Upcoming or past event associated with this place, organization, or - * action. + * The subject matter of the content. * - * @param Event|Event[] $event + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/event + * @see http://schema.org/about */ - public function event($event) + public function about($about) { - return $this->setProperty('event', $event); + return $this->setProperty('about', $about); } /** - * The subject matter of the content. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $about + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/about + * @see http://schema.org/actionStatus */ - public function about($about) + public function actionStatus($actionStatus) { - return $this->setProperty('about', $about); + return $this->setProperty('actionStatus', $actionStatus); } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[]|string|string[] $inLanguage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/additionalType */ - public function inLanguage($inLanguage) + public function additionalType($additionalType) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of instrument. The language used on this action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Language|Language[] $language + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/language + * @see http://schema.org/agent */ - public function language($language) + public function agent($agent) { - return $this->setProperty('language', $language); + return $this->setProperty('agent', $agent); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * An alias for the item. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/alternateName */ - public function recipient($recipient) + public function alternateName($alternateName) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -157,288 +160,285 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param Thing|Thing[] $instrument + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/event */ - public function instrument($instrument) + public function event($event) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('event', $event); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/inLanguage */ - public function participant($participant) + public function inLanguage($inLanguage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('inLanguage', $inLanguage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of instrument. The language used on this action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/language */ - public function startTime($startTime) + public function language($language) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('language', $language); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Invoice.php b/src/Invoice.php index dd631e013..e5fd4ad1a 100644 --- a/src/Invoice.php +++ b/src/Invoice.php @@ -27,6 +27,39 @@ public function accountId($accountId) return $this->setProperty('accountId', $accountId); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The time interval used to compute the invoice. * @@ -102,319 +135,286 @@ public function customer($customer) } /** - * The minimum payment required at this time. - * - * @param MonetaryAmount|MonetaryAmount[]|PriceSpecification|PriceSpecification[] $minimumPaymentDue - * - * @return static - * - * @see http://schema.org/minimumPaymentDue - */ - public function minimumPaymentDue($minimumPaymentDue) - { - return $this->setProperty('minimumPaymentDue', $minimumPaymentDue); - } - - /** - * The date that payment is due. - * - * @param \DateTimeInterface|\DateTimeInterface[] $paymentDue - * - * @return static - * - * @see http://schema.org/paymentDue - */ - public function paymentDue($paymentDue) - { - return $this->setProperty('paymentDue', $paymentDue); - } - - /** - * The date that payment is due. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $paymentDueDate + * @param string|string[] $description * * @return static * - * @see http://schema.org/paymentDueDate + * @see http://schema.org/description */ - public function paymentDueDate($paymentDueDate) + public function description($description) { - return $this->setProperty('paymentDueDate', $paymentDueDate); + return $this->setProperty('description', $description); } /** - * The name of the credit card or other method of payment for the order. + * 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. * - * @param PaymentMethod|PaymentMethod[] $paymentMethod + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/paymentMethod + * @see http://schema.org/disambiguatingDescription */ - public function paymentMethod($paymentMethod) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('paymentMethod', $paymentMethod); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * An identifier for the method of payment used (e.g. the last 4 digits of - * the credit card). + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $paymentMethodId + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/paymentMethodId + * @see http://schema.org/identifier */ - public function paymentMethodId($paymentMethodId) + public function identifier($identifier) { - return $this->setProperty('paymentMethodId', $paymentMethodId); + return $this->setProperty('identifier', $identifier); } /** - * The status of payment; whether the invoice has been paid or not. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param PaymentStatusType|PaymentStatusType[]|string|string[] $paymentStatus + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/paymentStatus + * @see http://schema.org/image */ - public function paymentStatus($paymentStatus) + public function image($image) { - return $this->setProperty('paymentStatus', $paymentStatus); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/mainEntityOfPage */ - public function provider($provider) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('provider', $provider); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The Order(s) related to this Invoice. One or more Orders may be combined - * into a single Invoice. + * The minimum payment required at this time. * - * @param Order|Order[] $referencesOrder + * @param MonetaryAmount|MonetaryAmount[]|PriceSpecification|PriceSpecification[] $minimumPaymentDue * * @return static * - * @see http://schema.org/referencesOrder + * @see http://schema.org/minimumPaymentDue */ - public function referencesOrder($referencesOrder) + public function minimumPaymentDue($minimumPaymentDue) { - return $this->setProperty('referencesOrder', $referencesOrder); + return $this->setProperty('minimumPaymentDue', $minimumPaymentDue); } /** - * The date the invoice is scheduled to be paid. + * The name of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $scheduledPaymentDate + * @param string|string[] $name * * @return static * - * @see http://schema.org/scheduledPaymentDate + * @see http://schema.org/name */ - public function scheduledPaymentDate($scheduledPaymentDate) + public function name($name) { - return $this->setProperty('scheduledPaymentDate', $scheduledPaymentDate); + return $this->setProperty('name', $name); } /** - * The total amount due. + * The date that payment is due. * - * @param MonetaryAmount|MonetaryAmount[]|PriceSpecification|PriceSpecification[] $totalPaymentDue + * @param \DateTimeInterface|\DateTimeInterface[] $paymentDue * * @return static * - * @see http://schema.org/totalPaymentDue + * @see http://schema.org/paymentDue */ - public function totalPaymentDue($totalPaymentDue) + public function paymentDue($paymentDue) { - return $this->setProperty('totalPaymentDue', $totalPaymentDue); + return $this->setProperty('paymentDue', $paymentDue); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The date that payment is due. * - * @param string|string[] $additionalType + * @param \DateTimeInterface|\DateTimeInterface[] $paymentDueDate * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/paymentDueDate */ - public function additionalType($additionalType) + public function paymentDueDate($paymentDueDate) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('paymentDueDate', $paymentDueDate); } /** - * An alias for the item. + * The name of the credit card or other method of payment for the order. * - * @param string|string[] $alternateName + * @param PaymentMethod|PaymentMethod[] $paymentMethod * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/paymentMethod */ - public function alternateName($alternateName) + public function paymentMethod($paymentMethod) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('paymentMethod', $paymentMethod); } /** - * A description of the item. + * An identifier for the method of payment used (e.g. the last 4 digits of + * the credit card). * - * @param string|string[] $description + * @param string|string[] $paymentMethodId * * @return static * - * @see http://schema.org/description + * @see http://schema.org/paymentMethodId */ - public function description($description) + public function paymentMethodId($paymentMethodId) { - return $this->setProperty('description', $description); + return $this->setProperty('paymentMethodId', $paymentMethodId); } /** - * 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. + * The status of payment; whether the invoice has been paid or not. * - * @param string|string[] $disambiguatingDescription + * @param PaymentStatusType|PaymentStatusType[]|string|string[] $paymentStatus * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/paymentStatus */ - public function disambiguatingDescription($disambiguatingDescription) + public function paymentStatus($paymentStatus) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('paymentStatus', $paymentStatus); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/image + * @see http://schema.org/provider */ - public function image($image) + public function provider($provider) { - return $this->setProperty('image', $image); + return $this->setProperty('provider', $provider); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The Order(s) related to this Invoice. One or more Orders may be combined + * into a single Invoice. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Order|Order[] $referencesOrder * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/referencesOrder */ - public function mainEntityOfPage($mainEntityOfPage) + public function referencesOrder($referencesOrder) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('referencesOrder', $referencesOrder); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The date the invoice is scheduled to be paid. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $scheduledPaymentDate * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/scheduledPaymentDate */ - public function potentialAction($potentialAction) + public function scheduledPaymentDate($scheduledPaymentDate) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('scheduledPaymentDate', $scheduledPaymentDate); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The total amount due. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param MonetaryAmount|MonetaryAmount[]|PriceSpecification|PriceSpecification[] $totalPaymentDue * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/totalPaymentDue */ - public function subjectOf($subjectOf) + public function totalPaymentDue($totalPaymentDue) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('totalPaymentDue', $totalPaymentDue); } /** diff --git a/src/ItemList.php b/src/ItemList.php index 5d3c9cd39..c44f855ff 100644 --- a/src/ItemList.php +++ b/src/ItemList.php @@ -15,61 +15,6 @@ */ class ItemList extends BaseType implements IntangibleContract, ThingContract { - /** - * For itemListElement values, you can use simple strings (e.g. "Peter", - * "Paul", "Mary"), existing entities, or use ListItem. - * - * Text values are best if the elements in the list are plain strings. - * Existing entities are best for a simple, unordered list of existing - * things in your data. ListItem is used with ordered lists when you want to - * provide additional context about the element in that list or when the - * same item might be in different places in different lists. - * - * Note: The order of elements in your mark-up is not sufficient for - * indicating the order or elements. Use ListItem with a 'position' - * property in such cases. - * - * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement - * - * @return static - * - * @see http://schema.org/itemListElement - */ - public function itemListElement($itemListElement) - { - return $this->setProperty('itemListElement', $itemListElement); - } - - /** - * Type of ordering (e.g. Ascending, Descending, Unordered). - * - * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder - * - * @return static - * - * @see http://schema.org/itemListOrder - */ - public function itemListOrder($itemListOrder) - { - return $this->setProperty('itemListOrder', $itemListOrder); - } - - /** - * The number of items in an ItemList. Note that some descriptions might not - * fully describe all items in a list (e.g., multi-page pagination); in such - * cases, the numberOfItems would be for the entire list. - * - * @param int|int[] $numberOfItems - * - * @return static - * - * @see http://schema.org/numberOfItems - */ - public function numberOfItems($numberOfItems) - { - return $this->setProperty('numberOfItems', $numberOfItems); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -167,6 +112,45 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -197,6 +181,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/ItemPage.php b/src/ItemPage.php index b409491f8..e6c236c1e 100644 --- a/src/ItemPage.php +++ b/src/ItemPage.php @@ -14,176 +14,6 @@ */ class ItemPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -328,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -343,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -444,6 +307,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -634,6 +512,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -860,13 +769,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -996,6 +938,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1041,6 +998,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1056,6 +1027,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1086,6 +1073,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1116,6 +1117,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1214,6 +1244,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1243,6 +1287,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1257,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1274,6 +1349,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1323,6 +1428,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1339,6 +1497,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1460,6 +1632,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1503,190 +1689,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/JewelryStore.php b/src/JewelryStore.php index 975091d35..dcef47054 100644 --- a/src/JewelryStore.php +++ b/src/JewelryStore.php @@ -17,126 +17,104 @@ class JewelryStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/JobPosting.php b/src/JobPosting.php index 8eefec573..1b4f5e469 100644 --- a/src/JobPosting.php +++ b/src/JobPosting.php @@ -13,6 +13,39 @@ */ class JobPosting extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The base salary of the job or of an employee in an EmployeeRole. * @@ -55,6 +88,37 @@ public function datePosted($datePosted) return $this->setProperty('datePosted', $datePosted); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Educational background needed for the position or Occupation. * @@ -131,6 +195,39 @@ public function hiringOrganization($hiringOrganization) return $this->setProperty('hiringOrganization', $hiringOrganization); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * Description of bonus and commission compensation aspects of the job. * @@ -202,6 +299,36 @@ public function jobLocation($jobLocation) return $this->setProperty('jobLocation', $jobLocation); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * A category describing the job, preferably using a term from a taxonomy * such as [BLS O*NET-SOC](http://www.onetcenter.org/taxonomy.html), @@ -224,6 +351,21 @@ public function occupationalCategory($occupationalCategory) return $this->setProperty('occupationalCategory', $occupationalCategory); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Specific qualifications required for this role or Occupation. * @@ -282,6 +424,22 @@ public function salaryCurrency($salaryCurrency) return $this->setProperty('salaryCurrency', $salaryCurrency); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Skills required to fulfill this role or in this Occupation. * @@ -312,233 +470,75 @@ public function specialCommitments($specialCommitments) } /** - * The title of the job. - * - * @param string|string[] $title - * - * @return static - * - * @see http://schema.org/title - */ - public function title($title) - { - return $this->setProperty('title', $title); - } - - /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough - * - * @return static - * - * @see http://schema.org/validThrough - */ - public function validThrough($validThrough) - { - return $this->setProperty('validThrough', $validThrough); - } - - /** - * The typical working hours for this job (e.g. 1st shift, night shift, - * 8am-5pm). - * - * @param string|string[] $workHours - * - * @return static - * - * @see http://schema.org/workHours - */ - public function workHours($workHours) - { - return $this->setProperty('workHours', $workHours); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The title of the job. * - * @param Action|Action[] $potentialAction + * @param string|string[] $title * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/title */ - public function potentialAction($potentialAction) + public function title($title) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('title', $title); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * The typical working hours for this job (e.g. 1st shift, night shift, + * 8am-5pm). * - * @param string|string[] $url + * @param string|string[] $workHours * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workHours */ - public function url($url) + public function workHours($workHours) { - return $this->setProperty('url', $url); + return $this->setProperty('workHours', $workHours); } } diff --git a/src/JoinAction.php b/src/JoinAction.php index 857b122cf..125d8e64c 100644 --- a/src/JoinAction.php +++ b/src/JoinAction.php @@ -24,32 +24,36 @@ class JoinAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { /** - * Upcoming or past event associated with this place, organization, or - * action. + * Indicates the current disposition of the Action. * - * @param Event|Event[] $event + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/event + * @see http://schema.org/actionStatus */ - public function event($event) + public function actionStatus($actionStatus) { - return $this->setProperty('event', $event); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -68,325 +72,321 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/event */ - public function participant($participant) + public function event($event) { - return $this->setProperty('participant', $participant); + return $this->setProperty('event', $event); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/LakeBodyOfWater.php b/src/LakeBodyOfWater.php index 86c5aeae5..6a5452f28 100644 --- a/src/LakeBodyOfWater.php +++ b/src/LakeBodyOfWater.php @@ -37,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -66,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -146,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -234,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -308,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -350,6 +463,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -392,6 +519,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -435,6 +577,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -482,189 +640,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Landform.php b/src/Landform.php index 91f3f2731..0f5da44ed 100644 --- a/src/Landform.php +++ b/src/Landform.php @@ -38,6 +38,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -67,6 +86,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -147,6 +180,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -235,6 +299,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -309,6 +406,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -351,6 +464,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -393,6 +520,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -436,6 +578,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -483,189 +641,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/LandmarksOrHistoricalBuildings.php b/src/LandmarksOrHistoricalBuildings.php index 3cb5c1cc8..bbcf304ee 100644 --- a/src/LandmarksOrHistoricalBuildings.php +++ b/src/LandmarksOrHistoricalBuildings.php @@ -35,6 +35,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -64,6 +83,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -144,6 +177,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -232,6 +296,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -306,6 +403,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -348,6 +461,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -390,6 +517,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -433,6 +575,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -480,189 +638,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/LeaveAction.php b/src/LeaveAction.php index 533f84c62..f225e9258 100644 --- a/src/LeaveAction.php +++ b/src/LeaveAction.php @@ -21,32 +21,36 @@ class LeaveAction extends BaseType implements InteractActionContract, ActionContract, ThingContract { /** - * Upcoming or past event associated with this place, organization, or - * action. + * Indicates the current disposition of the Action. * - * @param Event|Event[] $event + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/event + * @see http://schema.org/actionStatus */ - public function event($event) + public function actionStatus($actionStatus) { - return $this->setProperty('event', $event); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -65,325 +69,321 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/event */ - public function participant($participant) + public function event($event) { - return $this->setProperty('participant', $participant); + return $this->setProperty('event', $event); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/LegalService.php b/src/LegalService.php index b4b388db5..39ff87895 100644 --- a/src/LegalService.php +++ b/src/LegalService.php @@ -20,126 +20,104 @@ class LegalService extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -184,6 +162,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -227,6 +240,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -244,6 +322,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -430,22 +539,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -475,6 +612,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -491,6 +675,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -549,6 +748,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -563,6 +793,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -622,6 +894,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -650,6 +936,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -680,664 +1009,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/LegislativeBuilding.php b/src/LegislativeBuilding.php index d5b1362e5..83ce2fb6d 100644 --- a/src/LegislativeBuilding.php +++ b/src/LegislativeBuilding.php @@ -15,35 +15,6 @@ */ class LegislativeBuilding extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/LendAction.php b/src/LendAction.php index 87335c3a4..14b7d8717 100644 --- a/src/LendAction.php +++ b/src/LendAction.php @@ -20,77 +20,111 @@ class LendAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The person that borrows the object being - * lent. + * Indicates the current disposition of the Action. * - * @param Person|Person[] $borrower + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/borrower + * @see http://schema.org/actionStatus */ - public function borrower($borrower) + public function actionStatus($actionStatus) { - return $this->setProperty('borrower', $borrower); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The original location of the object or the - * agent before the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $fromLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/additionalType */ - public function fromLocation($fromLocation) + public function additionalType($additionalType) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Place|Place[] $toLocation + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/agent */ - public function toLocation($toLocation) + public function agent($agent) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A sub property of participant. The person that borrows the object being + * lent. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param Person|Person[] $borrower * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/borrower */ - public function agent($agent) + public function borrower($borrower) { - return $this->setProperty('agent', $agent); + return $this->setProperty('borrower', $borrower); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -131,288 +165,254 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Thing|Thing[] $object + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/object + * @see http://schema.org/fromLocation */ - public function object($object) + public function fromLocation($fromLocation) { - return $this->setProperty('object', $object); + return $this->setProperty('fromLocation', $fromLocation); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/Library.php b/src/Library.php index abf97ed96..ae44c2c96 100644 --- a/src/Library.php +++ b/src/Library.php @@ -16,126 +16,104 @@ class Library extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/LikeAction.php b/src/LikeAction.php index f3cb252ef..4a5ecae12 100644 --- a/src/LikeAction.php +++ b/src/LikeAction.php @@ -31,340 +31,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/LiquorStore.php b/src/LiquorStore.php index 0bbc4e9ce..f554a510c 100644 --- a/src/LiquorStore.php +++ b/src/LiquorStore.php @@ -18,126 +18,104 @@ class LiquorStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -182,6 +160,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -225,6 +238,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -242,6 +320,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -428,22 +537,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -473,6 +610,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -489,6 +673,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -547,6 +746,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -561,6 +791,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -620,6 +892,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -648,6 +934,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -678,664 +1007,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ListItem.php b/src/ListItem.php index c38f632af..ebb75edb7 100644 --- a/src/ListItem.php +++ b/src/ListItem.php @@ -13,63 +13,6 @@ */ class ListItem extends BaseType implements IntangibleContract, ThingContract { - /** - * An entity represented by an entry in a list or data feed (e.g. an - * 'artist' in a list of 'artists')’. - * - * @param Thing|Thing[] $item - * - * @return static - * - * @see http://schema.org/item - */ - public function item($item) - { - return $this->setProperty('item', $item); - } - - /** - * A link to the ListItem that follows the current one. - * - * @param ListItem|ListItem[] $nextItem - * - * @return static - * - * @see http://schema.org/nextItem - */ - public function nextItem($nextItem) - { - return $this->setProperty('nextItem', $nextItem); - } - - /** - * The position of an item in a series or sequence of items. - * - * @param int|int[]|string|string[] $position - * - * @return static - * - * @see http://schema.org/position - */ - public function position($position) - { - return $this->setProperty('position', $position); - } - - /** - * A link to the ListItem that preceeds the current one. - * - * @param ListItem|ListItem[] $previousItem - * - * @return static - * - * @see http://schema.org/previousItem - */ - public function previousItem($previousItem) - { - return $this->setProperty('previousItem', $previousItem); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -167,6 +110,21 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * An entity represented by an entry in a list or data feed (e.g. an + * 'artist' in a list of 'artists')’. + * + * @param Thing|Thing[] $item + * + * @return static + * + * @see http://schema.org/item + */ + public function item($item) + { + return $this->setProperty('item', $item); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -197,6 +155,34 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A link to the ListItem that follows the current one. + * + * @param ListItem|ListItem[] $nextItem + * + * @return static + * + * @see http://schema.org/nextItem + */ + public function nextItem($nextItem) + { + return $this->setProperty('nextItem', $nextItem); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -212,6 +198,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A link to the ListItem that preceeds the current one. + * + * @param ListItem|ListItem[] $previousItem + * + * @return static + * + * @see http://schema.org/previousItem + */ + public function previousItem($previousItem) + { + return $this->setProperty('previousItem', $previousItem); + } + /** * 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 diff --git a/src/ListenAction.php b/src/ListenAction.php index 01513e34a..135ef839a 100644 --- a/src/ListenAction.php +++ b/src/ListenAction.php @@ -31,33 +31,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -76,325 +79,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/LiteraryEvent.php b/src/LiteraryEvent.php index 070e213ac..5201ac4cd 100644 --- a/src/LiteraryEvent.php +++ b/src/LiteraryEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/LiveBlogPosting.php b/src/LiveBlogPosting.php index 17bc8c089..c70f236c4 100644 --- a/src/LiveBlogPosting.php +++ b/src/LiveBlogPosting.php @@ -17,191 +17,6 @@ */ class LiveBlogPosting extends BaseType implements BlogPostingContract, SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract { - /** - * The time when the live blog will stop covering the Event. Note that - * coverage may continue after the Event concludes. - * - * @param \DateTimeInterface|\DateTimeInterface[] $coverageEndTime - * - * @return static - * - * @see http://schema.org/coverageEndTime - */ - public function coverageEndTime($coverageEndTime) - { - return $this->setProperty('coverageEndTime', $coverageEndTime); - } - - /** - * The time when the live blog will begin covering the Event. Note that - * coverage may begin before the Event's start time. The LiveBlogPosting may - * also be created before coverage begins. - * - * @param \DateTimeInterface|\DateTimeInterface[] $coverageStartTime - * - * @return static - * - * @see http://schema.org/coverageStartTime - */ - public function coverageStartTime($coverageStartTime) - { - return $this->setProperty('coverageStartTime', $coverageStartTime); - } - - /** - * An update to the LiveBlog. - * - * @param BlogPosting|BlogPosting[] $liveBlogUpdate - * - * @return static - * - * @see http://schema.org/liveBlogUpdate - */ - public function liveBlogUpdate($liveBlogUpdate) - { - return $this->setProperty('liveBlogUpdate', $liveBlogUpdate); - } - - /** - * A CreativeWork such as an image, video, or audio clip shared as part of - * this posting. - * - * @param CreativeWork|CreativeWork[] $sharedContent - * - * @return static - * - * @see http://schema.org/sharedContent - */ - public function sharedContent($sharedContent) - { - return $this->setProperty('sharedContent', $sharedContent); - } - - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -346,6 +161,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -361,6 +195,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -375,6 +223,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -594,16 +471,47 @@ public function copyrightYear($copyrightYear) } /** - * The creator/author of this CreativeWork. This is the same as the Author - * property for CreativeWork. + * The time when the live blog will stop covering the Event. Note that + * coverage may continue after the Event concludes. * - * @param Organization|Organization[]|Person|Person[] $creator + * @param \DateTimeInterface|\DateTimeInterface[] $coverageEndTime * * @return static * - * @see http://schema.org/creator + * @see http://schema.org/coverageEndTime */ - public function creator($creator) + public function coverageEndTime($coverageEndTime) + { + return $this->setProperty('coverageEndTime', $coverageEndTime); + } + + /** + * The time when the live blog will begin covering the Event. Note that + * coverage may begin before the Event's start time. The LiveBlogPosting may + * also be created before coverage begins. + * + * @param \DateTimeInterface|\DateTimeInterface[] $coverageStartTime + * + * @return static + * + * @see http://schema.org/coverageStartTime + */ + public function coverageStartTime($coverageStartTime) + { + return $this->setProperty('coverageStartTime', $coverageStartTime); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) { return $this->setProperty('creator', $creator); } @@ -652,6 +560,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -877,6 +816,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1044,6 +1016,20 @@ public function license($license) return $this->setProperty('license', $license); } + /** + * An update to the LiveBlog. + * + * @param BlogPosting|BlogPosting[] $liveBlogUpdate + * + * @return static + * + * @see http://schema.org/liveBlogUpdate + */ + public function liveBlogUpdate($liveBlogUpdate) + { + return $this->setProperty('liveBlogUpdate', $liveBlogUpdate); + } + /** * The location where the CreativeWork was created, which may not be the * same as the location depicted in the CreativeWork. @@ -1074,6 +1060,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1104,6 +1106,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1120,6 +1136,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1134,6 +1193,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1275,6 +1349,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1292,6 +1382,21 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A CreativeWork such as an image, video, or audio clip shared as part of + * this posting. + * + * @param CreativeWork|CreativeWork[] $sharedContent + * + * @return static + * + * @see http://schema.org/sharedContent + */ + public function sharedContent($sharedContent) + { + return $this->setProperty('sharedContent', $sharedContent); + } + /** * The Organization on whose behalf the creator was working. * @@ -1341,6 +1446,45 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + /** * 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 @@ -1357,6 +1501,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1478,6 +1636,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1507,204 +1679,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/LoanOrCredit.php b/src/LoanOrCredit.php index 03dc359d0..82f0434c4 100644 --- a/src/LoanOrCredit.php +++ b/src/LoanOrCredit.php @@ -17,108 +17,82 @@ class LoanOrCredit extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** - * The amount of money. - * - * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount - * - * @return static - * - * @see http://schema.org/amount - */ - public function amount($amount) - { - return $this->setProperty('amount', $amount); - } - - /** - * The duration of the loan or credit agreement. - * - * @param QuantitativeValue|QuantitativeValue[] $loanTerm - * - * @return static - * - * @see http://schema.org/loanTerm - */ - public function loanTerm($loanTerm) - { - return $this->setProperty('loanTerm', $loanTerm); - } - - /** - * Assets required to secure loan or credit repayments. It may take form of - * third party pledge, goods, financial instruments (cash, securities, etc.) + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[]|string|string[] $requiredCollateral + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/requiredCollateral + * @see http://schema.org/additionalType */ - public function requiredCollateral($requiredCollateral) + public function additionalType($additionalType) { - return $this->setProperty('requiredCollateral', $requiredCollateral); + return $this->setProperty('additionalType', $additionalType); } /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/aggregateRating */ - public function annualPercentageRate($annualPercentageRate) + public function aggregateRating($aggregateRating) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * An alias for the item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/alternateName */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function alternateName($alternateName) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('alternateName', $alternateName); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * The amount of money. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param MonetaryAmount|MonetaryAmount[]|float|float[]|int|int[] $amount * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/amount */ - public function interestRate($interestRate) + public function amount($amount) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('amount', $amount); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/annualPercentageRate */ - public function aggregateRating($aggregateRating) + public function annualPercentageRate($annualPercentageRate) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -225,6 +199,52 @@ public function category($category) return $this->setProperty('category', $category); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. + * + * @param string|string[] $feesAndCommissionsSpecification + * + * @return static + * + * @see http://schema.org/feesAndCommissionsSpecification + */ + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + { + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -255,351 +275,331 @@ public function hoursAvailable($hoursAvailable) } /** - * A pointer to another, somehow related product (or multiple products). - * - * @param Product|Product[]|Service|Service[] $isRelatedTo - * - * @return static - * - * @see http://schema.org/isRelatedTo - */ - public function isRelatedTo($isRelatedTo) - { - return $this->setProperty('isRelatedTo', $isRelatedTo); - } - - /** - * A pointer to another, functionally similar product (or multiple - * products). + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/identifier */ - public function isSimilarTo($isSimilarTo) + public function identifier($identifier) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('identifier', $identifier); } /** - * An associated logo. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/image */ - public function logo($logo) + public function image($image) { - return $this->setProperty('logo', $logo); + return $this->setProperty('image', $image); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param Offer|Offer[] $offers + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/interestRate */ - public function offers($offers) + public function interestRate($interestRate) { - return $this->setProperty('offers', $offers); + return $this->setProperty('interestRate', $interestRate); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * A pointer to another, somehow related product (or multiple products). * - * @param Thing|Thing[] $produces + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/isRelatedTo */ - public function produces($produces) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('produces', $produces); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param Organization|Organization[]|Person|Person[] $provider + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/isSimilarTo */ - public function provider($provider) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('provider', $provider); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * The duration of the loan or credit agreement. * - * @param string|string[] $providerMobility + * @param QuantitativeValue|QuantitativeValue[] $loanTerm * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/loanTerm */ - public function providerMobility($providerMobility) + public function loanTerm($loanTerm) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('loanTerm', $loanTerm); } /** - * A review of the item. + * An associated logo. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/logo */ - public function review($review) + public function logo($logo) { - return $this->setProperty('review', $review); + return $this->setProperty('logo', $logo); } /** - * The geographic area where the service is provided. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/mainEntityOfPage */ - public function serviceArea($serviceArea) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The audience eligible for this service. + * The name of the item. * - * @param Audience|Audience[] $serviceAudience + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/name */ - public function serviceAudience($serviceAudience) + public function name($name) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('name', $name); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param Thing|Thing[] $serviceOutput + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/offers */ - public function serviceOutput($serviceOutput) + public function offers($offers) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('offers', $offers); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $serviceType + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/potentialAction */ - public function serviceType($serviceType) + public function potentialAction($potentialAction) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A slogan or motto associated with the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $slogan + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/produces */ - public function slogan($slogan) + public function produces($produces) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('produces', $produces); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/provider */ - public function additionalType($additionalType) + public function provider($provider) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('provider', $provider); } /** - * An alias for the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $alternateName + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/providerMobility */ - public function alternateName($alternateName) + public function providerMobility($providerMobility) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('providerMobility', $providerMobility); } /** - * A description of the item. + * Assets required to secure loan or credit repayments. It may take form of + * third party pledge, goods, financial instruments (cash, securities, etc.) * - * @param string|string[] $description + * @param Thing|Thing[]|string|string[] $requiredCollateral * * @return static * - * @see http://schema.org/description + * @see http://schema.org/requiredCollateral */ - public function description($description) + public function requiredCollateral($requiredCollateral) { - return $this->setProperty('description', $description); + return $this->setProperty('requiredCollateral', $requiredCollateral); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** diff --git a/src/LocalBusiness.php b/src/LocalBusiness.php index 226387577..c74dde38d 100644 --- a/src/LocalBusiness.php +++ b/src/LocalBusiness.php @@ -17,126 +17,104 @@ class LocalBusiness extends BaseType implements OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/LocationFeatureSpecification.php b/src/LocationFeatureSpecification.php index c2a2b2aee..75a1c1897 100644 --- a/src/LocationFeatureSpecification.php +++ b/src/LocationFeatureSpecification.php @@ -18,354 +18,354 @@ class LocationFeatureSpecification extends BaseType implements PropertyValueContract, StructuredValueContract, IntangibleContract, ThingContract { /** - * The hours during which this service or contact is available. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/additionalType */ - public function hoursAvailable($hoursAvailable) + public function additionalType($additionalType) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('additionalType', $additionalType); } /** - * The date when the item becomes valid. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/validFrom + * @see http://schema.org/alternateName */ - public function validFrom($validFrom) + public function alternateName($alternateName) { - return $this->setProperty('validFrom', $validFrom); + return $this->setProperty('alternateName', $alternateName); } /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * @param string|string[] $description * * @return static * - * @see http://schema.org/validThrough + * @see http://schema.org/description */ - public function validThrough($validThrough) + public function description($description) { - return $this->setProperty('validThrough', $validThrough); + return $this->setProperty('description', $description); } /** - * The upper value of some characteristic or property. + * 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. * - * @param float|float[]|int|int[] $maxValue + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/maxValue + * @see http://schema.org/disambiguatingDescription */ - public function maxValue($maxValue) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('maxValue', $maxValue); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The lower value of some characteristic or property. + * The hours during which this service or contact is available. * - * @param float|float[]|int|int[] $minValue + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/minValue + * @see http://schema.org/hoursAvailable */ - public function minValue($minValue) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('minValue', $minValue); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * A commonly used identifier for the characteristic represented by the - * property, e.g. a manufacturer or a standard code for a property. - * propertyID can be - * (1) a prefixed string, mainly meant to be used with standards for product - * properties; (2) a site-specific, non-prefixed string (e.g. the primary - * key of the property or the vendor-specific id of the property), or (3) - * a URL indicating the type of the property, either pointing to an external - * vocabulary, or a Web resource that describes the property (e.g. a - * glossary entry). - * Standards bodies should promote a standard prefix for the identifiers of - * properties from their standards. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $propertyID + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/propertyID + * @see http://schema.org/identifier */ - public function propertyID($propertyID) + public function identifier($identifier) { - return $this->setProperty('propertyID', $propertyID); + return $this->setProperty('identifier', $identifier); } /** - * The unit of measurement given using the UN/CEFACT Common Code (3 - * characters) or a URL. Other codes than the UN/CEFACT Common Code may be - * used with a prefix followed by a colon. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $unitCode + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/unitCode + * @see http://schema.org/image */ - public function unitCode($unitCode) + public function image($image) { - return $this->setProperty('unitCode', $unitCode); + return $this->setProperty('image', $image); } /** - * A string or text indicating the unit of measurement. Useful if you cannot - * provide a standard unit code for - * unitCode. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $unitText + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/unitText + * @see http://schema.org/mainEntityOfPage */ - public function unitText($unitText) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('unitText', $unitText); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The value of the quantitative value or property value node. - * - * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type - * for values is 'Number'. - * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or - * 'StructuredValue'. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. + * The upper value of some characteristic or property. * - * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value + * @param float|float[]|int|int[] $maxValue * * @return static * - * @see http://schema.org/value + * @see http://schema.org/maxValue */ - public function value($value) + public function maxValue($maxValue) { - return $this->setProperty('value', $value); + return $this->setProperty('maxValue', $maxValue); } /** - * A pointer to a secondary value that provides additional information on - * the original value, e.g. a reference temperature. + * The lower value of some characteristic or property. * - * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * @param float|float[]|int|int[] $minValue * * @return static * - * @see http://schema.org/valueReference + * @see http://schema.org/minValue */ - public function valueReference($valueReference) + public function minValue($minValue) { - return $this->setProperty('valueReference', $valueReference); + return $this->setProperty('minValue', $minValue); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A commonly used identifier for the characteristic represented by the + * property, e.g. a manufacturer or a standard code for a property. + * propertyID can be + * (1) a prefixed string, mainly meant to be used with standards for product + * properties; (2) a site-specific, non-prefixed string (e.g. the primary + * key of the property or the vendor-specific id of the property), or (3) + * a URL indicating the type of the property, either pointing to an external + * vocabulary, or a Web resource that describes the property (e.g. a + * glossary entry). + * Standards bodies should promote a standard prefix for the identifiers of + * properties from their standards. * - * @param string|string[] $description + * @param string|string[] $propertyID * * @return static * - * @see http://schema.org/description + * @see http://schema.org/propertyID */ - public function description($description) + public function propertyID($propertyID) { - return $this->setProperty('description', $description); + return $this->setProperty('propertyID', $propertyID); } /** - * 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. + * 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. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/sameAs */ - public function disambiguatingDescription($disambiguatingDescription) + public function sameAs($sameAs) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('sameAs', $sameAs); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A CreativeWork or Event about this Thing. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/subjectOf */ - public function identifier($identifier) + public function subjectOf($subjectOf) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('subjectOf', $subjectOf); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The unit of measurement given using the UN/CEFACT Common Code (3 + * characters) or a URL. Other codes than the UN/CEFACT Common Code may be + * used with a prefix followed by a colon. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $unitCode * * @return static * - * @see http://schema.org/image + * @see http://schema.org/unitCode */ - public function image($image) + public function unitCode($unitCode) { - return $this->setProperty('image', $image); + return $this->setProperty('unitCode', $unitCode); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A string or text indicating the unit of measurement. Useful if you cannot + * provide a standard unit code for + * unitCode. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $unitText * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/unitText */ - public function mainEntityOfPage($mainEntityOfPage) + public function unitText($unitText) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('unitText', $unitText); } /** - * The name of the item. + * URL of the item. * - * @param string|string[] $name + * @param string|string[] $url * * @return static * - * @see http://schema.org/name + * @see http://schema.org/url */ - public function name($name) + public function url($url) { - return $this->setProperty('name', $name); + return $this->setProperty('url', $url); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The date when the item becomes valid. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/validFrom */ - public function potentialAction($potentialAction) + public function validFrom($validFrom) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('validFrom', $validFrom); } /** - * 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. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validThrough */ - public function sameAs($sameAs) + public function validThrough($validThrough) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validThrough', $validThrough); } /** - * A CreativeWork or Event about this Thing. + * The value of the quantitative value or property value node. + * + * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type + * for values is 'Number'. + * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or + * 'StructuredValue'. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/value */ - public function subjectOf($subjectOf) + public function value($value) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('value', $value); } /** - * URL of the item. + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. * - * @param string|string[] $url + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference * * @return static * - * @see http://schema.org/url + * @see http://schema.org/valueReference */ - public function url($url) + public function valueReference($valueReference) { - return $this->setProperty('url', $url); + return $this->setProperty('valueReference', $valueReference); } } diff --git a/src/Locksmith.php b/src/Locksmith.php index 08e1afe91..152ed79b1 100644 --- a/src/Locksmith.php +++ b/src/Locksmith.php @@ -17,126 +17,104 @@ class Locksmith extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/LodgingBusiness.php b/src/LodgingBusiness.php index 5e3b45783..a8a3e184d 100644 --- a/src/LodgingBusiness.php +++ b/src/LodgingBusiness.php @@ -16,352 +16,395 @@ class LodgingBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/additionalProperty */ - public function amenityFeature($amenityFeature) + public function additionalProperty($additionalProperty) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * An intended audience, i.e. a group for whom something was created. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Audience|Audience[] $audience + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/additionalType */ - public function audience($audience) + public function additionalType($additionalType) { - return $this->setProperty('audience', $audience); + return $this->setProperty('additionalType', $additionalType); } /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * Physical address of the item. * - * @param Language|Language[]|string|string[] $availableLanguage + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/availableLanguage + * @see http://schema.org/address */ - public function availableLanguage($availableLanguage) + public function address($address) { - return $this->setProperty('availableLanguage', $availableLanguage); + return $this->setProperty('address', $address); } /** - * The earliest someone may check into a lodging establishment. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/checkinTime + * @see http://schema.org/aggregateRating */ - public function checkinTime($checkinTime) + public function aggregateRating($aggregateRating) { - return $this->setProperty('checkinTime', $checkinTime); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The latest someone may check out of a lodging establishment. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/checkoutTime + * @see http://schema.org/alternateName */ - public function checkoutTime($checkoutTime) + public function alternateName($alternateName) { - return $this->setProperty('checkoutTime', $checkoutTime); + return $this->setProperty('alternateName', $alternateName); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/amenityFeature */ - public function numberOfRooms($numberOfRooms) + public function amenityFeature($amenityFeature) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * The geographic area where a service or offered item is provided. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/areaServed */ - public function petsAllowed($petsAllowed) + public function areaServed($areaServed) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('areaServed', $areaServed); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * An intended audience, i.e. a group for whom something was created. * - * @param Rating|Rating[] $starRating + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/audience */ - public function starRating($starRating) + public function audience($audience) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('audience', $audience); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] * - * @param Organization|Organization[] $branchOf + * @param Language|Language[]|string|string[] $availableLanguage * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/availableLanguage */ - public function branchOf($branchOf) + public function availableLanguage($availableLanguage) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('availableLanguage', $availableLanguage); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An award won by or for this item. * - * @param string|string[] $currenciesAccepted + * @param string|string[] $award * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/award */ - public function currenciesAccepted($currenciesAccepted) + public function award($award) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('award', $award); } /** - * 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 '-'. + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * The earliest someone may check into a lodging establishment. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime * * @return static * - * @see http://schema.org/address + * @see http://schema.org/checkinTime */ - public function address($address) + public function checkinTime($checkinTime) { - return $this->setProperty('address', $address); + return $this->setProperty('checkinTime', $checkinTime); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The latest someone may check out of a lodging establishment. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/checkoutTime */ - public function aggregateRating($aggregateRating) + public function checkoutTime($checkoutTime) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('checkoutTime', $checkoutTime); } /** - * The geographic area where a service or offered item is provided. + * A contact point for a person or organization. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/contactPoint */ - public function areaServed($areaServed) + public function contactPoint($contactPoint) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('contactPoint', $contactPoint); } /** - * An award won by or for this item. + * A contact point for a person or organization. * - * @param string|string[] $award + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/award + * @see http://schema.org/contactPoints */ - public function award($award) + public function contactPoints($contactPoints) { - return $this->setProperty('award', $award); + return $this->setProperty('contactPoints', $contactPoints); } /** - * Awards won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $awards + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containedIn */ - public function awards($awards) + public function containedIn($containedIn) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containedIn', $containedIn); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The basic containment relation between a place and one that contains it. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/containedInPlace */ - public function brand($brand) + public function containedInPlace($containedInPlace) { - return $this->setProperty('brand', $brand); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A contact point for a person or organization. + * The basic containment relation between a place and another that it + * contains. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/containsPlace */ - public function contactPoint($contactPoint) + public function containsPlace($containsPlace) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('containsPlace', $containsPlace); } /** - * A contact point for a person or organization. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/currenciesAccepted */ - public function contactPoints($contactPoints) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department + * + * @return static + * + * @see http://schema.org/department + */ + public function department($department) + { + return $this->setProperty('department', $department); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -549,6 +592,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -566,6 +623,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -596,868 +667,780 @@ public function hasPOS($hasPOS) } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. - * - * @param string|string[] $isicV4 - * - * @return static - * - * @see http://schema.org/isicV4 - */ - public function isicV4($isicV4) - { - return $this->setProperty('isicV4', $isicV4); - } - - /** - * The official name of the organization, e.g. the registered company name. - * - * @param string|string[] $legalName - * - * @return static - * - * @see http://schema.org/legalName - */ - public function legalName($legalName) - { - return $this->setProperty('legalName', $legalName); - } - - /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. - * - * @param string|string[] $leiCode - * - * @return static - * - * @see http://schema.org/leiCode - */ - public function leiCode($leiCode) - { - return $this->setProperty('leiCode', $leiCode); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * An associated logo. - * - * @param ImageObject|ImageObject[]|string|string[] $logo - * - * @return static - * - * @see http://schema.org/logo - */ - public function logo($logo) - { - return $this->setProperty('logo', $logo); - } - - /** - * A pointer to products or services offered by the organization or person. - * - * @param Offer|Offer[] $makesOffer - * - * @return static - * - * @see http://schema.org/makesOffer - */ - public function makesOffer($makesOffer) - { - return $this->setProperty('makesOffer', $makesOffer); - } - - /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $vatID + * @param string|string[] $naics * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/naics */ - public function vatID($vatID) + public function naics($naics) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('naics', $naics); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $alternateName + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/numberOfEmployees */ - public function alternateName($alternateName) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * A description of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfRooms */ - public function description($description) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param string|string[] $sameAs + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/petsAllowed */ - public function sameAs($sameAs) + public function petsAllowed($petsAllowed) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * A CreativeWork or Event about this Thing. + * A photograph of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photo */ - public function subjectOf($subjectOf) + public function photo($photo) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photo', $photo); } /** - * URL of the item. + * Photographs of this place. * - * @param string|string[] $url + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/url + * @see http://schema.org/photos */ - public function url($url) + public function photos($photos) { - return $this->setProperty('url', $url); + return $this->setProperty('photos', $photos); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/potentialAction */ - public function additionalProperty($additionalProperty) + public function potentialAction($potentialAction) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * The price range of the business, for example ```$$$```. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/priceRange */ - public function amenityFeature($amenityFeature) + public function priceRange($priceRange) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('priceRange', $priceRange); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $branchCode + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publicAccess */ - public function branchCode($branchCode) + public function publicAccess($publicAccess) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedIn + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publishingPrinciples */ - public function containedIn($containedIn) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/review */ - public function containedInPlace($containedInPlace) + public function review($review) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and another that it - * contains. + * Review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/reviews */ - public function containsPlace($containsPlace) + public function reviews($reviews) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('reviews', $reviews); } /** - * The geo coordinates of the place. + * 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. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/sameAs */ - public function geo($geo) + public function sameAs($sameAs) { - return $this->setProperty('geo', $geo); + return $this->setProperty('sameAs', $sameAs); } /** - * A URL to a map of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param Map|Map[]|string|string[] $hasMap + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/seeks */ - public function hasMap($hasMap) + public function seeks($seeks) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('seeks', $seeks); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/LodgingReservation.php b/src/LodgingReservation.php index 19ecf7045..8efe7dcea 100644 --- a/src/LodgingReservation.php +++ b/src/LodgingReservation.php @@ -19,466 +19,466 @@ class LodgingReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** - * The earliest someone may check into a lodging establishment. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/checkinTime + * @see http://schema.org/additionalType */ - public function checkinTime($checkinTime) + public function additionalType($additionalType) { - return $this->setProperty('checkinTime', $checkinTime); + return $this->setProperty('additionalType', $additionalType); } /** - * The latest someone may check out of a lodging establishment. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/checkoutTime + * @see http://schema.org/alternateName */ - public function checkoutTime($checkoutTime) + public function alternateName($alternateName) { - return $this->setProperty('checkoutTime', $checkoutTime); + return $this->setProperty('alternateName', $alternateName); } /** - * A full description of the lodging unit. + * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as + * a booking agent. * - * @param string|string[] $lodgingUnitDescription + * @param Organization|Organization[]|Person|Person[] $bookingAgent * * @return static * - * @see http://schema.org/lodgingUnitDescription + * @see http://schema.org/bookingAgent */ - public function lodgingUnitDescription($lodgingUnitDescription) + public function bookingAgent($bookingAgent) { - return $this->setProperty('lodgingUnitDescription', $lodgingUnitDescription); + return $this->setProperty('bookingAgent', $bookingAgent); } /** - * Textual description of the unit type (including suite vs. room, size of - * bed, etc.). + * The date and time the reservation was booked. * - * @param QualitativeValue|QualitativeValue[]|string|string[] $lodgingUnitType + * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime * * @return static * - * @see http://schema.org/lodgingUnitType + * @see http://schema.org/bookingTime */ - public function lodgingUnitType($lodgingUnitType) + public function bookingTime($bookingTime) { - return $this->setProperty('lodgingUnitType', $lodgingUnitType); + return $this->setProperty('bookingTime', $bookingTime); } /** - * The number of adults staying in the unit. + * An entity that arranges for an exchange between a buyer and a seller. In + * most cases a broker never acquires or releases ownership of a product or + * service involved in an exchange. If it is not clear whether an entity is + * a broker, seller, or buyer, the latter two terms are preferred. * - * @param QuantitativeValue|QuantitativeValue[]|int|int[] $numAdults + * @param Organization|Organization[]|Person|Person[] $broker * * @return static * - * @see http://schema.org/numAdults + * @see http://schema.org/broker */ - public function numAdults($numAdults) + public function broker($broker) { - return $this->setProperty('numAdults', $numAdults); + return $this->setProperty('broker', $broker); } /** - * The number of children staying in the unit. + * The earliest someone may check into a lodging establishment. * - * @param QuantitativeValue|QuantitativeValue[]|int|int[] $numChildren + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime * * @return static * - * @see http://schema.org/numChildren + * @see http://schema.org/checkinTime */ - public function numChildren($numChildren) + public function checkinTime($checkinTime) { - return $this->setProperty('numChildren', $numChildren); + return $this->setProperty('checkinTime', $checkinTime); } /** - * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as - * a booking agent. + * The latest someone may check out of a lodging establishment. * - * @param Organization|Organization[]|Person|Person[] $bookingAgent + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime * * @return static * - * @see http://schema.org/bookingAgent + * @see http://schema.org/checkoutTime */ - public function bookingAgent($bookingAgent) + public function checkoutTime($checkoutTime) { - return $this->setProperty('bookingAgent', $bookingAgent); + return $this->setProperty('checkoutTime', $checkoutTime); } /** - * The date and time the reservation was booked. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $bookingTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/bookingTime + * @see http://schema.org/description */ - public function bookingTime($bookingTime) + public function description($description) { - return $this->setProperty('bookingTime', $bookingTime); + return $this->setProperty('description', $description); } /** - * An entity that arranges for an exchange between a buyer and a seller. In - * most cases a broker never acquires or releases ownership of a product or - * service involved in an exchange. If it is not clear whether an entity is - * a broker, seller, or buyer, the latter two terms are preferred. + * 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. * - * @param Organization|Organization[]|Person|Person[] $broker + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/broker + * @see http://schema.org/disambiguatingDescription */ - public function broker($broker) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('broker', $broker); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The date and time the reservation was modified. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/identifier */ - public function modifiedTime($modifiedTime) + public function identifier($identifier) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('identifier', $identifier); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $priceCurrency + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/image */ - public function priceCurrency($priceCurrency) + public function image($image) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('image', $image); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * A full description of the lodging unit. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param string|string[] $lodgingUnitDescription * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/lodgingUnitDescription */ - public function programMembershipUsed($programMembershipUsed) + public function lodgingUnitDescription($lodgingUnitDescription) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('lodgingUnitDescription', $lodgingUnitDescription); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * Textual description of the unit type (including suite vs. room, size of + * bed, etc.). * - * @param Organization|Organization[]|Person|Person[] $provider + * @param QualitativeValue|QualitativeValue[]|string|string[] $lodgingUnitType * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/lodgingUnitType */ - public function provider($provider) + public function lodgingUnitType($lodgingUnitType) { - return $this->setProperty('provider', $provider); + return $this->setProperty('lodgingUnitType', $lodgingUnitType); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $reservationFor + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/mainEntityOfPage */ - public function reservationFor($reservationFor) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A unique identifier for the reservation. + * The date and time the reservation was modified. * - * @param string|string[] $reservationId + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/modifiedTime */ - public function reservationId($reservationId) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The current status of the reservation. + * The name of the item. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/name */ - public function reservationStatus($reservationStatus) + public function name($name) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('name', $name); } /** - * A ticket associated with the reservation. + * The number of adults staying in the unit. * - * @param Ticket|Ticket[] $reservedTicket + * @param QuantitativeValue|QuantitativeValue[]|int|int[] $numAdults * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/numAdults */ - public function reservedTicket($reservedTicket) + public function numAdults($numAdults) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('numAdults', $numAdults); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. + * The number of children staying in the unit. * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * @param QuantitativeValue|QuantitativeValue[]|int|int[] $numChildren * * @return static * - * @see http://schema.org/totalPrice + * @see http://schema.org/numChildren */ - public function totalPrice($totalPrice) + public function numChildren($numChildren) { - return $this->setProperty('totalPrice', $totalPrice); + return $this->setProperty('numChildren', $numChildren); } /** - * The person or organization the reservation or ticket is for. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Organization|Organization[]|Person|Person[] $underName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/underName + * @see http://schema.org/potentialAction */ - public function underName($underName) + public function potentialAction($potentialAction) { - return $this->setProperty('underName', $underName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $additionalType + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/priceCurrency */ - public function additionalType($additionalType) + public function priceCurrency($priceCurrency) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An alias for the item. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $alternateName + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/programMembershipUsed */ - public function alternateName($alternateName) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * A description of the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/description + * @see http://schema.org/provider */ - public function description($description) + public function provider($provider) { - return $this->setProperty('description', $description); + return $this->setProperty('provider', $provider); } /** - * 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. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/reservationFor */ - public function disambiguatingDescription($disambiguatingDescription) + public function reservationFor($reservationFor) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('reservationFor', $reservationFor); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A unique identifier for the reservation. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reservationId */ - public function identifier($identifier) + public function reservationId($reservationId) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reservationId', $reservationId); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The current status of the reservation. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservationStatus */ - public function image($image) + public function reservationStatus($reservationStatus) { - return $this->setProperty('image', $image); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A ticket associated with the reservation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/reservedTicket */ - public function mainEntityOfPage($mainEntityOfPage) + public function reservedTicket($reservedTicket) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('reservedTicket', $reservedTicket); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param string|string[] $sameAs + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/totalPrice */ - public function sameAs($sameAs) + public function totalPrice($totalPrice) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('totalPrice', $totalPrice); } /** - * A CreativeWork or Event about this Thing. + * The person or organization the reservation or ticket is for. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Organization|Organization[]|Person|Person[] $underName * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/underName */ - public function subjectOf($subjectOf) + public function underName($underName) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('underName', $underName); } /** diff --git a/src/LoseAction.php b/src/LoseAction.php index 3b5b830dd..9f13f5aaa 100644 --- a/src/LoseAction.php +++ b/src/LoseAction.php @@ -15,31 +15,36 @@ class LoseAction extends BaseType implements AchieveActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The winner of the action. + * Indicates the current disposition of the Action. * - * @param Person|Person[] $winner + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/winner + * @see http://schema.org/actionStatus */ - public function winner($winner) + public function actionStatus($actionStatus) { - return $this->setProperty('winner', $winner); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -58,339 +63,334 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * A sub property of participant. The winner of the action. * - * @param string|string[] $url + * @param Person|Person[] $winner * * @return static * - * @see http://schema.org/url + * @see http://schema.org/winner */ - public function url($url) + public function winner($winner) { - return $this->setProperty('url', $url); + return $this->setProperty('winner', $winner); } } diff --git a/src/Map.php b/src/Map.php index edefcd1b7..644a02a2c 100644 --- a/src/Map.php +++ b/src/Map.php @@ -13,20 +13,6 @@ */ class Map extends BaseType implements CreativeWorkContract, ThingContract { - /** - * Indicates the kind of Map, from the MapCategoryType Enumeration. - * - * @param MapCategoryType|MapCategoryType[] $mapType - * - * @return static - * - * @see http://schema.org/mapType - */ - public function mapType($mapType) - { - return $this->setProperty('mapType', $mapType); - } - /** * The subject matter of the content. * @@ -171,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -186,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -477,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -702,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -899,6 +982,36 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * Indicates the kind of Map, from the MapCategoryType Enumeration. + * + * @param MapCategoryType|MapCategoryType[] $mapType + * + * @return static + * + * @see http://schema.org/mapType + */ + public function mapType($mapType) + { + return $this->setProperty('mapType', $mapType); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -929,6 +1042,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -959,6 +1086,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1100,6 +1242,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1182,6 +1340,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1303,6 +1475,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1346,190 +1532,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MarryAction.php b/src/MarryAction.php index 3ada4a894..c68671e4d 100644 --- a/src/MarryAction.php +++ b/src/MarryAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/MediaObject.php b/src/MediaObject.php index 9966ba4c0..7e65a0a88 100644 --- a/src/MediaObject.php +++ b/src/MediaObject.php @@ -17,284 +17,6 @@ */ class MediaObject extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A NewsArticle associated with the Media Object. - * - * @param NewsArticle|NewsArticle[] $associatedArticle - * - * @return static - * - * @see http://schema.org/associatedArticle - */ - public function associatedArticle($associatedArticle) - { - return $this->setProperty('associatedArticle', $associatedArticle); - } - - /** - * The bitrate of the media object. - * - * @param string|string[] $bitrate - * - * @return static - * - * @see http://schema.org/bitrate - */ - public function bitrate($bitrate) - { - return $this->setProperty('bitrate', $bitrate); - } - - /** - * File size in (mega/kilo) bytes. - * - * @param string|string[] $contentSize - * - * @return static - * - * @see http://schema.org/contentSize - */ - public function contentSize($contentSize) - { - return $this->setProperty('contentSize', $contentSize); - } - - /** - * Actual bytes of the media object, for example the image file or video - * file. - * - * @param string|string[] $contentUrl - * - * @return static - * - * @see http://schema.org/contentUrl - */ - public function contentUrl($contentUrl) - { - return $this->setProperty('contentUrl', $contentUrl); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * A URL pointing to a player for a specific video. In general, this is the - * information in the ```src``` element of an ```embed``` tag and should not - * be the same as the content of the ```loc``` tag. - * - * @param string|string[] $embedUrl - * - * @return static - * - * @see http://schema.org/embedUrl - */ - public function embedUrl($embedUrl) - { - return $this->setProperty('embedUrl', $embedUrl); - } - - /** - * The CreativeWork encoded by this media object. - * - * @param CreativeWork|CreativeWork[] $encodesCreativeWork - * - * @return static - * - * @see http://schema.org/encodesCreativeWork - */ - public function encodesCreativeWork($encodesCreativeWork) - { - return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); - } - - /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside - * particular [[encodingFormat]] information. - * - * Unregistered or niche encoding and file formats can be indicated instead - * via the most appropriate URL, e.g. defining Web page or a - * Wikipedia/Wikidata entry. - * - * @param string|string[] $encodingFormat - * - * @return static - * - * @see http://schema.org/encodingFormat - */ - public function encodingFormat($encodingFormat) - { - return $this->setProperty('encodingFormat', $encodingFormat); - } - - /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime - * - * @return static - * - * @see http://schema.org/endTime - */ - public function endTime($endTime) - { - return $this->setProperty('endTime', $endTime); - } - - /** - * The height of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height - * - * @return static - * - * @see http://schema.org/height - */ - public function height($height) - { - return $this->setProperty('height', $height); - } - - /** - * Player type required—for example, Flash or Silverlight. - * - * @param string|string[] $playerType - * - * @return static - * - * @see http://schema.org/playerType - */ - public function playerType($playerType) - { - return $this->setProperty('playerType', $playerType); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The regions where the media is allowed. If not specified, then it's - * assumed to be allowed everywhere. Specify the countries in [ISO 3166 - * format](http://en.wikipedia.org/wiki/ISO_3166). - * - * @param Place|Place[] $regionsAllowed - * - * @return static - * - * @see http://schema.org/regionsAllowed - */ - public function regionsAllowed($regionsAllowed) - { - return $this->setProperty('regionsAllowed', $regionsAllowed); - } - - /** - * Indicates if use of the media require a subscription (either paid or - * free). Allowed values are ```true``` or ```false``` (note that an earlier - * version had 'yes', 'no'). - * - * @param bool|bool[] $requiresSubscription - * - * @return static - * - * @see http://schema.org/requiresSubscription - */ - public function requiresSubscription($requiresSubscription) - { - return $this->setProperty('requiresSubscription', $requiresSubscription); - } - - /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime - * - * @return static - * - * @see http://schema.org/startTime - */ - public function startTime($startTime) - { - return $this->setProperty('startTime', $startTime); - } - - /** - * Date when this media object was uploaded to this site. - * - * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate - * - * @return static - * - * @see http://schema.org/uploadDate - */ - public function uploadDate($uploadDate) - { - return $this->setProperty('uploadDate', $uploadDate); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - /** * The subject matter of the content. * @@ -439,6 +161,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -454,6 +195,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -468,6 +223,20 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -555,6 +324,20 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + /** * Fictional person connected with a creative work. * @@ -643,6 +426,35 @@ public function contentRating($contentRating) return $this->setProperty('contentRating', $contentRating); } + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + /** * A secondary contributor to the CreativeWork or Event. * @@ -720,29 +532,60 @@ public function dateCreated($dateCreated) * The date on which the CreativeWork was most recently modified or when the * item's entry was modified within a DataFeed. * - * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified + * + * @return static + * + * @see http://schema.org/dateModified + */ + public function dateModified($dateModified) + { + return $this->setProperty('dateModified', $dateModified); + } + + /** + * Date of first broadcast/publication. + * + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A description of the item. + * + * @param string|string[] $description * * @return static * - * @see http://schema.org/dateModified + * @see http://schema.org/description */ - public function dateModified($dateModified) + public function description($description) { - return $this->setProperty('dateModified', $dateModified); + return $this->setProperty('description', $description); } /** - * Date of first broadcast/publication. + * 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. * - * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/datePublished + * @see http://schema.org/disambiguatingDescription */ - public function datePublished($datePublished) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('datePublished', $datePublished); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -759,6 +602,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -802,6 +660,36 @@ public function educationalUse($educationalUse) return $this->setProperty('educationalUse', $educationalUse); } + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for associatedMedia. @@ -858,6 +746,29 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -970,6 +881,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1167,6 +1125,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1197,6 +1171,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1213,6 +1201,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + /** * The position of an item in a series or sequence of items. * @@ -1227,6 +1229,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1242,6 +1259,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1325,6 +1357,22 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1340,6 +1388,22 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + /** * A review of the item. * @@ -1355,17 +1419,33 @@ public function review($review) } /** - * Review of the item. + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * 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. * - * @param Review|Review[] $reviews + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/sameAs */ - public function reviews($reviews) + public function sameAs($sameAs) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('sameAs', $sameAs); } /** @@ -1450,6 +1530,43 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1572,232 +1689,88 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Date when this media object was uploaded to this site. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/uploadDate */ - public function mainEntityOfPage($mainEntityOfPage) + public function uploadDate($uploadDate) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('uploadDate', $uploadDate); } /** - * The name of the item. + * URL of the item. * - * @param string|string[] $name + * @param string|string[] $url * * @return static * - * @see http://schema.org/name + * @see http://schema.org/url */ - public function name($name) + public function url($url) { - return $this->setProperty('name', $name); + return $this->setProperty('url', $url); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The version of the CreativeWork embodied by a specified resource. * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/version */ - public function potentialAction($potentialAction) + public function version($version) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('version', $version); } /** - * 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. + * An embedded video object. * - * @param string|string[] $sameAs + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/video */ - public function sameAs($sameAs) + public function video($video) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('video', $video); } /** - * A CreativeWork or Event about this Thing. + * The width of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/width */ - public function subjectOf($subjectOf) + public function width($width) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('width', $width); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/MediaSubscription.php b/src/MediaSubscription.php index 56708859c..7d22d9d29 100644 --- a/src/MediaSubscription.php +++ b/src/MediaSubscription.php @@ -14,36 +14,6 @@ */ class MediaSubscription extends BaseType implements IntangibleContract, ThingContract { - /** - * The Organization responsible for authenticating the user's subscription. - * For example, many media apps require a cable/satellite provider to - * authenticate your subscription before playing media. - * - * @param Organization|Organization[] $authenticator - * - * @return static - * - * @see http://schema.org/authenticator - */ - public function authenticator($authenticator) - { - return $this->setProperty('authenticator', $authenticator); - } - - /** - * - * - * @param $expectsAcceptanceOf - * - * @return static - * - * @see http://schema.org/expectsAcceptanceOf - */ - public function expectsAcceptanceOf($expectsAcceptanceOf) - { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -77,6 +47,22 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The Organization responsible for authenticating the user's subscription. + * For example, many media apps require a cable/satellite provider to + * authenticate your subscription before playing media. + * + * @param Organization|Organization[] $authenticator + * + * @return static + * + * @see http://schema.org/authenticator + */ + public function authenticator($authenticator) + { + return $this->setProperty('authenticator', $authenticator); + } + /** * A description of the item. * @@ -108,6 +94,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * + * + * @param $expectsAcceptanceOf + * + * @return static + * + * @see http://schema.org/expectsAcceptanceOf + */ + public function expectsAcceptanceOf($expectsAcceptanceOf) + { + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides diff --git a/src/MedicalOrganization.php b/src/MedicalOrganization.php index d233bf1b3..3a059429e 100644 --- a/src/MedicalOrganization.php +++ b/src/MedicalOrganization.php @@ -14,6 +14,25 @@ */ class MedicalOrganization extends BaseType implements OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -43,6 +62,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -145,6 +178,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -376,6 +440,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -450,6 +547,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -523,6 +636,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -580,6 +707,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -632,6 +774,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -707,6 +865,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -737,203 +909,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/MeetingRoom.php b/src/MeetingRoom.php index aaa7374f7..56712b23e 100644 --- a/src/MeetingRoom.php +++ b/src/MeetingRoom.php @@ -22,133 +22,104 @@ class MeetingRoom extends BaseType implements RoomContract, AccommodationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard - * - * @param QuantitativeValue|QuantitativeValue[] $floorSize - * - * @return static - * - * @see http://schema.org/floorSize - */ - public function floorSize($floorSize) - { - return $this->setProperty('floorSize', $floorSize); - } - - /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/additionalProperty */ - public function numberOfRooms($numberOfRooms) + public function additionalProperty($additionalProperty) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Indications regarding the permitted usage of the accommodation. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $permittedUsage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/permittedUsage + * @see http://schema.org/additionalType */ - public function permittedUsage($permittedUsage) + public function additionalType($additionalType) { - return $this->setProperty('permittedUsage', $permittedUsage); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * Physical address of the item. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/address */ - public function petsAllowed($petsAllowed) + public function address($address) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('address', $address); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/aggregateRating */ - public function additionalProperty($additionalProperty) + public function aggregateRating($aggregateRating) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -214,6 +185,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -257,6 +259,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -302,6 +320,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -376,6 +427,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -419,320 +486,253 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * A review of the item. + * The name of the item. * - * @param Review|Review[] $review + * @param string|string[] $name * * @return static * - * @see http://schema.org/review + * @see http://schema.org/name */ - public function review($review) + public function name($name) { - return $this->setProperty('review', $review); + return $this->setProperty('name', $name); } /** - * Review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/numberOfRooms */ - public function reviews($reviews) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/MensClothingStore.php b/src/MensClothingStore.php index b86fb51e1..ae0206bd4 100644 --- a/src/MensClothingStore.php +++ b/src/MensClothingStore.php @@ -17,126 +17,104 @@ class MensClothingStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Menu.php b/src/Menu.php index 43e8da4a7..ef86fe1a0 100644 --- a/src/Menu.php +++ b/src/Menu.php @@ -14,34 +14,6 @@ */ class Menu extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A food or drink item contained in a menu or menu section. - * - * @param MenuItem|MenuItem[] $hasMenuItem - * - * @return static - * - * @see http://schema.org/hasMenuItem - */ - public function hasMenuItem($hasMenuItem) - { - return $this->setProperty('hasMenuItem', $hasMenuItem); - } - - /** - * A subgrouping of the menu (by dishes, course, serving time period, etc.). - * - * @param MenuSection|MenuSection[] $hasMenuSection - * - * @return static - * - * @see http://schema.org/hasMenuSection - */ - public function hasMenuSection($hasMenuSection) - { - return $this->setProperty('hasMenuSection', $hasMenuSection); - } - /** * The subject matter of the content. * @@ -186,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -201,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -492,6 +497,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -688,6 +724,34 @@ public function genre($genre) return $this->setProperty('genre', $genre); } + /** + * A food or drink item contained in a menu or menu section. + * + * @param MenuItem|MenuItem[] $hasMenuItem + * + * @return static + * + * @see http://schema.org/hasMenuItem + */ + public function hasMenuItem($hasMenuItem) + { + return $this->setProperty('hasMenuItem', $hasMenuItem); + } + + /** + * A subgrouping of the menu (by dishes, course, serving time period, etc.). + * + * @param MenuSection|MenuSection[] $hasMenuSection + * + * @return static + * + * @see http://schema.org/hasMenuSection + */ + public function hasMenuSection($hasMenuSection) + { + return $this->setProperty('hasMenuSection', $hasMenuSection); + } + /** * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). @@ -717,6 +781,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -914,6 +1011,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -944,6 +1057,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -974,6 +1101,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1115,6 +1257,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1197,6 +1355,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1318,6 +1490,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1361,190 +1547,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MenuItem.php b/src/MenuItem.php index 1c40b6090..a54fee543 100644 --- a/src/MenuItem.php +++ b/src/MenuItem.php @@ -13,67 +13,6 @@ */ class MenuItem extends BaseType implements CreativeWorkContract, ThingContract { - /** - * Additional menu item(s) such as a side dish of salad or side order of - * fries that can be added to this menu item. Additionally it can be a menu - * section containing allowed add-on menu items for this menu item. - * - * @param MenuItem|MenuItem[]|MenuSection|MenuSection[] $menuAddOn - * - * @return static - * - * @see http://schema.org/menuAddOn - */ - public function menuAddOn($menuAddOn) - { - return $this->setProperty('menuAddOn', $menuAddOn); - } - - /** - * Nutrition information about the recipe or menu item. - * - * @param NutritionInformation|NutritionInformation[] $nutrition - * - * @return static - * - * @see http://schema.org/nutrition - */ - public function nutrition($nutrition) - { - return $this->setProperty('nutrition', $nutrition); - } - - /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. - * - * @param Offer|Offer[] $offers - * - * @return static - * - * @see http://schema.org/offers - */ - public function offers($offers) - { - return $this->setProperty('offers', $offers); - } - - /** - * Indicates a dietary restriction or guideline for which this recipe or - * menu item is suitable, e.g. diabetic, halal etc. - * - * @param RestrictedDiet|RestrictedDiet[] $suitableForDiet - * - * @return static - * - * @see http://schema.org/suitableForDiet - */ - public function suitableForDiet($suitableForDiet) - { - return $this->setProperty('suitableForDiet', $suitableForDiet); - } - /** * The subject matter of the content. * @@ -218,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -233,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -524,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -749,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -946,6 +982,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -976,6 +1028,50 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * Additional menu item(s) such as a side dish of salad or side order of + * fries that can be added to this menu item. Additionally it can be a menu + * section containing allowed add-on menu items for this menu item. + * + * @param MenuItem|MenuItem[]|MenuSection|MenuSection[] $menuAddOn + * + * @return static + * + * @see http://schema.org/menuAddOn + */ + public function menuAddOn($menuAddOn) + { + return $this->setProperty('menuAddOn', $menuAddOn); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Nutrition information about the recipe or menu item. + * + * @param NutritionInformation|NutritionInformation[] $nutrition + * + * @return static + * + * @see http://schema.org/nutrition + */ + public function nutrition($nutrition) + { + return $this->setProperty('nutrition', $nutrition); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1006,6 +1102,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1147,6 +1258,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1229,6 +1356,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Indicates a dietary restriction or guideline for which this recipe or + * menu item is suitable, e.g. diabetic, halal etc. + * + * @param RestrictedDiet|RestrictedDiet[] $suitableForDiet + * + * @return static + * + * @see http://schema.org/suitableForDiet + */ + public function suitableForDiet($suitableForDiet) + { + return $this->setProperty('suitableForDiet', $suitableForDiet); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1350,6 +1506,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1393,190 +1563,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MenuSection.php b/src/MenuSection.php index 969a0e41f..d6f9ddbc5 100644 --- a/src/MenuSection.php +++ b/src/MenuSection.php @@ -16,34 +16,6 @@ */ class MenuSection extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A food or drink item contained in a menu or menu section. - * - * @param MenuItem|MenuItem[] $hasMenuItem - * - * @return static - * - * @see http://schema.org/hasMenuItem - */ - public function hasMenuItem($hasMenuItem) - { - return $this->setProperty('hasMenuItem', $hasMenuItem); - } - - /** - * A subgrouping of the menu (by dishes, course, serving time period, etc.). - * - * @param MenuSection|MenuSection[] $hasMenuSection - * - * @return static - * - * @see http://schema.org/hasMenuSection - */ - public function hasMenuSection($hasMenuSection) - { - return $this->setProperty('hasMenuSection', $hasMenuSection); - } - /** * The subject matter of the content. * @@ -188,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -203,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -494,6 +499,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -690,6 +726,34 @@ public function genre($genre) return $this->setProperty('genre', $genre); } + /** + * A food or drink item contained in a menu or menu section. + * + * @param MenuItem|MenuItem[] $hasMenuItem + * + * @return static + * + * @see http://schema.org/hasMenuItem + */ + public function hasMenuItem($hasMenuItem) + { + return $this->setProperty('hasMenuItem', $hasMenuItem); + } + + /** + * A subgrouping of the menu (by dishes, course, serving time period, etc.). + * + * @param MenuSection|MenuSection[] $hasMenuSection + * + * @return static + * + * @see http://schema.org/hasMenuSection + */ + public function hasMenuSection($hasMenuSection) + { + return $this->setProperty('hasMenuSection', $hasMenuSection); + } + /** * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). @@ -719,6 +783,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -916,6 +1013,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -946,6 +1059,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -976,6 +1103,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1117,6 +1259,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1199,6 +1357,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1320,6 +1492,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1363,190 +1549,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Message.php b/src/Message.php index b144c314d..697fde561 100644 --- a/src/Message.php +++ b/src/Message.php @@ -13,136 +13,6 @@ */ class Message extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A sub property of recipient. The recipient blind copied on a message. - * - * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $bccRecipient - * - * @return static - * - * @see http://schema.org/bccRecipient - */ - public function bccRecipient($bccRecipient) - { - return $this->setProperty('bccRecipient', $bccRecipient); - } - - /** - * A sub property of recipient. The recipient copied on a message. - * - * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $ccRecipient - * - * @return static - * - * @see http://schema.org/ccRecipient - */ - public function ccRecipient($ccRecipient) - { - return $this->setProperty('ccRecipient', $ccRecipient); - } - - /** - * The date/time at which the message has been read by the recipient if a - * single recipient exists. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateRead - * - * @return static - * - * @see http://schema.org/dateRead - */ - public function dateRead($dateRead) - { - return $this->setProperty('dateRead', $dateRead); - } - - /** - * The date/time the message was received if a single recipient exists. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateReceived - * - * @return static - * - * @see http://schema.org/dateReceived - */ - public function dateReceived($dateReceived) - { - return $this->setProperty('dateReceived', $dateReceived); - } - - /** - * The date/time at which the message was sent. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateSent - * - * @return static - * - * @see http://schema.org/dateSent - */ - public function dateSent($dateSent) - { - return $this->setProperty('dateSent', $dateSent); - } - - /** - * A CreativeWork attached to the message. - * - * @param CreativeWork|CreativeWork[] $messageAttachment - * - * @return static - * - * @see http://schema.org/messageAttachment - */ - public function messageAttachment($messageAttachment) - { - return $this->setProperty('messageAttachment', $messageAttachment); - } - - /** - * A sub property of participant. The participant who is at the receiving - * end of the action. - * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient - * - * @return static - * - * @see http://schema.org/recipient - */ - public function recipient($recipient) - { - return $this->setProperty('recipient', $recipient); - } - - /** - * A sub property of participant. The participant who is at the sending end - * of the action. - * - * @param Audience|Audience[]|Organization|Organization[]|Person|Person[] $sender - * - * @return static - * - * @see http://schema.org/sender - */ - public function sender($sender) - { - return $this->setProperty('sender', $sender); - } - - /** - * A sub property of recipient. The recipient who was directly sent the - * message. - * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $toRecipient - * - * @return static - * - * @see http://schema.org/toRecipient - */ - public function toRecipient($toRecipient) - { - return $this->setProperty('toRecipient', $toRecipient); - } - /** * The subject matter of the content. * @@ -287,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -302,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -403,6 +306,34 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A sub property of recipient. The recipient blind copied on a message. + * + * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $bccRecipient + * + * @return static + * + * @see http://schema.org/bccRecipient + */ + public function bccRecipient($bccRecipient) + { + return $this->setProperty('bccRecipient', $bccRecipient); + } + + /** + * A sub property of recipient. The recipient copied on a message. + * + * @param ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $ccRecipient + * + * @return static + * + * @see http://schema.org/ccRecipient + */ + public function ccRecipient($ccRecipient) + { + return $this->setProperty('ccRecipient', $ccRecipient); + } + /** * Fictional person connected with a creative work. * @@ -594,87 +525,161 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * The date/time at which the message has been read by the recipient if a + * single recipient exists. * - * @param string|string[] $discussionUrl + * @param \DateTimeInterface|\DateTimeInterface[] $dateRead * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/dateRead */ - public function discussionUrl($discussionUrl) + public function dateRead($dateRead) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('dateRead', $dateRead); } /** - * Specifies the Person who edited the CreativeWork. + * The date/time the message was received if a single recipient exists. * - * @param Person|Person[] $editor + * @param \DateTimeInterface|\DateTimeInterface[] $dateReceived * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/dateReceived */ - public function editor($editor) + public function dateReceived($dateReceived) { - return $this->setProperty('editor', $editor); + return $this->setProperty('dateReceived', $dateReceived); } /** - * An alignment to an established educational framework. + * The date/time at which the message was sent. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param \DateTimeInterface|\DateTimeInterface[] $dateSent * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/dateSent */ - public function educationalAlignment($educationalAlignment) + public function dateSent($dateSent) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('dateSent', $dateSent); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * A description of the item. * - * @param string|string[] $educationalUse + * @param string|string[] $description * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/description */ - public function educationalUse($educationalUse) + public function description($description) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('description', $description); } /** - * A media object that encodes this CreativeWork. This property is a synonym - * for associatedMedia. + * 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. * - * @param MediaObject|MediaObject[] $encoding + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/encoding + * @see http://schema.org/disambiguatingDescription */ - public function encoding($encoding) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('encoding', $encoding); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside * particular [[encodingFormat]] information. * * Unregistered or niche encoding and file formats can be indicated instead @@ -818,6 +823,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1015,6 +1053,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1045,6 +1099,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * A CreativeWork attached to the message. + * + * @param CreativeWork|CreativeWork[] $messageAttachment + * + * @return static + * + * @see http://schema.org/messageAttachment + */ + public function messageAttachment($messageAttachment) + { + return $this->setProperty('messageAttachment', $messageAttachment); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1075,6 +1157,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1158,6 +1255,21 @@ public function publishingPrinciples($publishingPrinciples) return $this->setProperty('publishingPrinciples', $publishingPrinciples); } + /** + * A sub property of participant. The participant who is at the receiving + * end of the action. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * + * @return static + * + * @see http://schema.org/recipient + */ + public function recipient($recipient) + { + return $this->setProperty('recipient', $recipient); + } + /** * The Event where the CreativeWork was recorded. The CreativeWork may * capture all or part of the event. @@ -1216,6 +1328,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1233,6 +1361,21 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A sub property of participant. The participant who is at the sending end + * of the action. + * + * @param Audience|Audience[]|Organization|Organization[]|Person|Person[] $sender + * + * @return static + * + * @see http://schema.org/sender + */ + public function sender($sender) + { + return $this->setProperty('sender', $sender); + } + /** * The Organization on whose behalf the creator was working. * @@ -1298,6 +1441,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1389,6 +1546,21 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * A sub property of recipient. The recipient who was directly sent the + * message. + * + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $toRecipient + * + * @return static + * + * @see http://schema.org/toRecipient + */ + public function toRecipient($toRecipient) + { + return $this->setProperty('toRecipient', $toRecipient); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1419,6 +1591,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1462,190 +1648,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MiddleSchool.php b/src/MiddleSchool.php index 8f07f1e19..d8562f0ee 100644 --- a/src/MiddleSchool.php +++ b/src/MiddleSchool.php @@ -16,17 +16,22 @@ class MiddleSchool extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { /** - * Alumni of an organization. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $alumni + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/alumni + * @see http://schema.org/additionalType */ - public function alumni($alumni) + public function additionalType($additionalType) { - return $this->setProperty('alumni', $alumni); + return $this->setProperty('additionalType', $additionalType); } /** @@ -58,6 +63,34 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + /** * The geographic area where a service or offered item is provided. * @@ -160,6 +193,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -391,6 +455,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -465,6 +562,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -538,6 +651,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -595,6 +722,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -647,6 +789,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -722,6 +880,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -752,203 +924,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/MobileApplication.php b/src/MobileApplication.php index 02fc2c2e9..d7f628d32 100644 --- a/src/MobileApplication.php +++ b/src/MobileApplication.php @@ -16,542 +16,252 @@ class MobileApplication extends BaseType implements SoftwareApplicationContract, CreativeWorkContract, ThingContract { /** - * Specifies specific carrier(s) requirements for the application (e.g. an - * application may only work on a specific carrier network). - * - * @param string|string[] $carrierRequirements - * - * @return static - * - * @see http://schema.org/carrierRequirements - */ - public function carrierRequirements($carrierRequirements) - { - return $this->setProperty('carrierRequirements', $carrierRequirements); - } - - /** - * Type of software application, e.g. 'Game, Multimedia'. - * - * @param string|string[] $applicationCategory - * - * @return static - * - * @see http://schema.org/applicationCategory - */ - public function applicationCategory($applicationCategory) - { - return $this->setProperty('applicationCategory', $applicationCategory); - } - - /** - * Subcategory of the application, e.g. 'Arcade Game'. - * - * @param string|string[] $applicationSubCategory - * - * @return static - * - * @see http://schema.org/applicationSubCategory - */ - public function applicationSubCategory($applicationSubCategory) - { - return $this->setProperty('applicationSubCategory', $applicationSubCategory); - } - - /** - * The name of the application suite to which the application belongs (e.g. - * Excel belongs to Office). - * - * @param string|string[] $applicationSuite - * - * @return static - * - * @see http://schema.org/applicationSuite - */ - public function applicationSuite($applicationSuite) - { - return $this->setProperty('applicationSuite', $applicationSuite); - } - - /** - * Device required to run the application. Used in cases where a specific - * make/model is required to run the application. - * - * @param string|string[] $availableOnDevice - * - * @return static - * - * @see http://schema.org/availableOnDevice - */ - public function availableOnDevice($availableOnDevice) - { - return $this->setProperty('availableOnDevice', $availableOnDevice); - } - - /** - * Countries for which the application is not supported. You can also - * provide the two-letter ISO 3166-1 alpha-2 country code. - * - * @param string|string[] $countriesNotSupported - * - * @return static - * - * @see http://schema.org/countriesNotSupported - */ - public function countriesNotSupported($countriesNotSupported) - { - return $this->setProperty('countriesNotSupported', $countriesNotSupported); - } - - /** - * Countries for which the application is supported. You can also provide - * the two-letter ISO 3166-1 alpha-2 country code. - * - * @param string|string[] $countriesSupported - * - * @return static - * - * @see http://schema.org/countriesSupported - */ - public function countriesSupported($countriesSupported) - { - return $this->setProperty('countriesSupported', $countriesSupported); - } - - /** - * Device required to run the application. Used in cases where a specific - * make/model is required to run the application. - * - * @param string|string[] $device - * - * @return static - * - * @see http://schema.org/device - */ - public function device($device) - { - return $this->setProperty('device', $device); - } - - /** - * If the file can be downloaded, URL to download the binary. - * - * @param string|string[] $downloadUrl - * - * @return static - * - * @see http://schema.org/downloadUrl - */ - public function downloadUrl($downloadUrl) - { - return $this->setProperty('downloadUrl', $downloadUrl); - } - - /** - * Features or modules provided by this application (and possibly required - * by other applications). - * - * @param string|string[] $featureList - * - * @return static - * - * @see http://schema.org/featureList - */ - public function featureList($featureList) - { - return $this->setProperty('featureList', $featureList); - } - - /** - * Size of the application / package (e.g. 18MB). In the absence of a unit - * (MB, KB etc.), KB will be assumed. - * - * @param string|string[] $fileSize - * - * @return static - * - * @see http://schema.org/fileSize - */ - public function fileSize($fileSize) - { - return $this->setProperty('fileSize', $fileSize); - } - - /** - * URL at which the app may be installed, if different from the URL of the - * item. - * - * @param string|string[] $installUrl - * - * @return static - * - * @see http://schema.org/installUrl - */ - public function installUrl($installUrl) - { - return $this->setProperty('installUrl', $installUrl); - } - - /** - * Minimum memory requirements. - * - * @param string|string[] $memoryRequirements - * - * @return static - * - * @see http://schema.org/memoryRequirements - */ - public function memoryRequirements($memoryRequirements) - { - return $this->setProperty('memoryRequirements', $memoryRequirements); - } - - /** - * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). - * - * @param string|string[] $operatingSystem - * - * @return static - * - * @see http://schema.org/operatingSystem - */ - public function operatingSystem($operatingSystem) - { - return $this->setProperty('operatingSystem', $operatingSystem); - } - - /** - * Permission(s) required to run the app (for example, a mobile app may - * require full internet access or may run only on wifi). - * - * @param string|string[] $permissions - * - * @return static - * - * @see http://schema.org/permissions - */ - public function permissions($permissions) - { - return $this->setProperty('permissions', $permissions); - } - - /** - * Processor architecture required to run the application (e.g. IA64). - * - * @param string|string[] $processorRequirements - * - * @return static - * - * @see http://schema.org/processorRequirements - */ - public function processorRequirements($processorRequirements) - { - return $this->setProperty('processorRequirements', $processorRequirements); - } - - /** - * Description of what changed in this version. - * - * @param string|string[] $releaseNotes - * - * @return static - * - * @see http://schema.org/releaseNotes - */ - public function releaseNotes($releaseNotes) - { - return $this->setProperty('releaseNotes', $releaseNotes); - } - - /** - * Component dependency requirements for application. This includes runtime - * environments and shared libraries that are not included in the - * application distribution package, but required to run the application - * (Examples: DirectX, Java or .NET runtime). - * - * @param string|string[] $requirements - * - * @return static - * - * @see http://schema.org/requirements - */ - public function requirements($requirements) - { - return $this->setProperty('requirements', $requirements); - } - - /** - * A link to a screenshot image of the app. - * - * @param ImageObject|ImageObject[]|string|string[] $screenshot - * - * @return static - * - * @see http://schema.org/screenshot - */ - public function screenshot($screenshot) - { - return $this->setProperty('screenshot', $screenshot); - } - - /** - * Additional content for a software application. - * - * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn - * - * @return static - * - * @see http://schema.org/softwareAddOn - */ - public function softwareAddOn($softwareAddOn) - { - return $this->setProperty('softwareAddOn', $softwareAddOn); - } - - /** - * Software application help. + * The subject matter of the content. * - * @param CreativeWork|CreativeWork[] $softwareHelp + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/softwareHelp + * @see http://schema.org/about */ - public function softwareHelp($softwareHelp) + public function about($about) { - return $this->setProperty('softwareHelp', $softwareHelp); + return $this->setProperty('about', $about); } /** - * Component dependency requirements for application. This includes runtime - * environments and shared libraries that are not included in the - * application distribution package, but required to run the application - * (Examples: DirectX, Java or .NET runtime). + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. * - * @param string|string[] $softwareRequirements + * @param string|string[] $accessMode * * @return static * - * @see http://schema.org/softwareRequirements + * @see http://schema.org/accessMode */ - public function softwareRequirements($softwareRequirements) + public function accessMode($accessMode) { - return $this->setProperty('softwareRequirements', $softwareRequirements); + return $this->setProperty('accessMode', $accessMode); } /** - * Version of the software instance. + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. * - * @param string|string[] $softwareVersion + * @param ItemList|ItemList[] $accessModeSufficient * * @return static * - * @see http://schema.org/softwareVersion + * @see http://schema.org/accessModeSufficient */ - public function softwareVersion($softwareVersion) + public function accessModeSufficient($accessModeSufficient) { - return $this->setProperty('softwareVersion', $softwareVersion); + return $this->setProperty('accessModeSufficient', $accessModeSufficient); } /** - * Storage requirements (free space required). + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param string|string[] $storageRequirements + * @param string|string[] $accessibilityAPI * * @return static * - * @see http://schema.org/storageRequirements + * @see http://schema.org/accessibilityAPI */ - public function storageRequirements($storageRequirements) + public function accessibilityAPI($accessibilityAPI) { - return $this->setProperty('storageRequirements', $storageRequirements); + return $this->setProperty('accessibilityAPI', $accessibilityAPI); } /** - * Supporting data for a SoftwareApplication. + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param DataFeed|DataFeed[] $supportingData + * @param string|string[] $accessibilityControl * * @return static * - * @see http://schema.org/supportingData + * @see http://schema.org/accessibilityControl */ - public function supportingData($supportingData) + public function accessibilityControl($accessibilityControl) { - return $this->setProperty('supportingData', $supportingData); + return $this->setProperty('accessibilityControl', $accessibilityControl); } /** - * The subject matter of the content. + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Thing|Thing[] $about + * @param string|string[] $accessibilityFeature * * @return static * - * @see http://schema.org/about + * @see http://schema.org/accessibilityFeature */ - public function about($about) + public function accessibilityFeature($accessibilityFeature) { - return $this->setProperty('about', $about); + return $this->setProperty('accessibilityFeature', $accessibilityFeature); } /** - * The human sensory perceptual system or cognitive faculty through which a - * person may process or perceive information. Expected values include: - * auditory, tactile, textual, visual, colorDependent, chartOnVisual, - * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param string|string[] $accessMode + * @param string|string[] $accessibilityHazard * * @return static * - * @see http://schema.org/accessMode + * @see http://schema.org/accessibilityHazard */ - public function accessMode($accessMode) + public function accessibilityHazard($accessibilityHazard) { - return $this->setProperty('accessMode', $accessMode); + return $this->setProperty('accessibilityHazard', $accessibilityHazard); } /** - * A list of single or combined accessModes that are sufficient to - * understand all the intellectual content of a resource. Expected values - * include: auditory, tactile, textual, visual. + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." * - * @param ItemList|ItemList[] $accessModeSufficient + * @param string|string[] $accessibilitySummary * * @return static * - * @see http://schema.org/accessModeSufficient + * @see http://schema.org/accessibilitySummary */ - public function accessModeSufficient($accessModeSufficient) + public function accessibilitySummary($accessibilitySummary) { - return $this->setProperty('accessModeSufficient', $accessModeSufficient); + return $this->setProperty('accessibilitySummary', $accessibilitySummary); } /** - * Indicates that the resource is compatible with the referenced - * accessibility API ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * Specifies the Person that is legally accountable for the CreativeWork. * - * @param string|string[] $accessibilityAPI + * @param Person|Person[] $accountablePerson * * @return static * - * @see http://schema.org/accessibilityAPI + * @see http://schema.org/accountablePerson */ - public function accessibilityAPI($accessibilityAPI) + public function accountablePerson($accountablePerson) { - return $this->setProperty('accessibilityAPI', $accessibilityAPI); + return $this->setProperty('accountablePerson', $accountablePerson); } /** - * Identifies input methods that are sufficient to fully control the - * described resource ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $accessibilityControl + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/accessibilityControl + * @see http://schema.org/additionalType */ - public function accessibilityControl($accessibilityControl) + public function additionalType($additionalType) { - return $this->setProperty('accessibilityControl', $accessibilityControl); + return $this->setProperty('additionalType', $additionalType); } /** - * Content features of the resource, such as accessible media, alternatives - * and supported enhancements for accessibility ([WebSchemas wiki lists - * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $accessibilityFeature + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/accessibilityFeature + * @see http://schema.org/aggregateRating */ - public function accessibilityFeature($accessibilityFeature) + public function aggregateRating($aggregateRating) { - return $this->setProperty('accessibilityFeature', $accessibilityFeature); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * A characteristic of the described resource that is physiologically - * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas - * wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * An alias for the item. * - * @param string|string[] $accessibilityHazard + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/accessibilityHazard + * @see http://schema.org/alternateName */ - public function accessibilityHazard($accessibilityHazard) + public function alternateName($alternateName) { - return $this->setProperty('accessibilityHazard', $accessibilityHazard); + return $this->setProperty('alternateName', $alternateName); } /** - * A human-readable summary of specific accessibility features or - * deficiencies, consistent with the other accessibility metadata but - * expressing subtleties such as "short descriptions are present but long - * descriptions will be needed for non-visual users" or "short descriptions - * are present and no long descriptions are needed." + * A secondary title of the CreativeWork. * - * @param string|string[] $accessibilitySummary + * @param string|string[] $alternativeHeadline * * @return static * - * @see http://schema.org/accessibilitySummary + * @see http://schema.org/alternativeHeadline */ - public function accessibilitySummary($accessibilitySummary) + public function alternativeHeadline($alternativeHeadline) { - return $this->setProperty('accessibilitySummary', $accessibilitySummary); + return $this->setProperty('alternativeHeadline', $alternativeHeadline); } /** - * Specifies the Person that is legally accountable for the CreativeWork. + * Type of software application, e.g. 'Game, Multimedia'. * - * @param Person|Person[] $accountablePerson + * @param string|string[] $applicationCategory * * @return static * - * @see http://schema.org/accountablePerson + * @see http://schema.org/applicationCategory */ - public function accountablePerson($accountablePerson) + public function applicationCategory($applicationCategory) { - return $this->setProperty('accountablePerson', $accountablePerson); + return $this->setProperty('applicationCategory', $applicationCategory); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * Subcategory of the application, e.g. 'Arcade Game'. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $applicationSubCategory * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/applicationSubCategory */ - public function aggregateRating($aggregateRating) + public function applicationSubCategory($applicationSubCategory) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('applicationSubCategory', $applicationSubCategory); } /** - * A secondary title of the CreativeWork. + * The name of the application suite to which the application belongs (e.g. + * Excel belongs to Office). * - * @param string|string[] $alternativeHeadline + * @param string|string[] $applicationSuite * * @return static * - * @see http://schema.org/alternativeHeadline + * @see http://schema.org/applicationSuite */ - public function alternativeHeadline($alternativeHeadline) + public function applicationSuite($applicationSuite) { - return $this->setProperty('alternativeHeadline', $alternativeHeadline); + return $this->setProperty('applicationSuite', $applicationSuite); } /** @@ -613,6 +323,21 @@ public function author($author) return $this->setProperty('author', $author); } + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $availableOnDevice + * + * @return static + * + * @see http://schema.org/availableOnDevice + */ + public function availableOnDevice($availableOnDevice) + { + return $this->setProperty('availableOnDevice', $availableOnDevice); + } + /** * An award won by or for this item. * @@ -641,6 +366,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * Specifies specific carrier(s) requirements for the application (e.g. an + * application may only work on a specific carrier network). + * + * @param string|string[] $carrierRequirements + * + * @return static + * + * @see http://schema.org/carrierRequirements + */ + public function carrierRequirements($carrierRequirements) + { + return $this->setProperty('carrierRequirements', $carrierRequirements); + } + /** * Fictional person connected with a creative work. * @@ -772,6 +512,36 @@ public function copyrightYear($copyrightYear) return $this->setProperty('copyrightYear', $copyrightYear); } + /** + * Countries for which the application is not supported. You can also + * provide the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesNotSupported + * + * @return static + * + * @see http://schema.org/countriesNotSupported + */ + public function countriesNotSupported($countriesNotSupported) + { + return $this->setProperty('countriesNotSupported', $countriesNotSupported); + } + + /** + * Countries for which the application is supported. You can also provide + * the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesSupported + * + * @return static + * + * @see http://schema.org/countriesSupported + */ + public function countriesSupported($countriesSupported) + { + return $this->setProperty('countriesSupported', $countriesSupported); + } + /** * The creator/author of this CreativeWork. This is the same as the Author * property for CreativeWork. @@ -831,6 +601,52 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $device + * + * @return static + * + * @see http://schema.org/device + */ + public function device($device) + { + return $this->setProperty('device', $device); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -845,6 +661,20 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * If the file can be downloaded, URL to download the binary. + * + * @param string|string[] $downloadUrl + * + * @return static + * + * @see http://schema.org/downloadUrl + */ + public function downloadUrl($downloadUrl) + { + return $this->setProperty('downloadUrl', $downloadUrl); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -977,6 +807,21 @@ public function expires($expires) return $this->setProperty('expires', $expires); } + /** + * Features or modules provided by this application (and possibly required + * by other applications). + * + * @param string|string[] $featureList + * + * @return static + * + * @see http://schema.org/featureList + */ + public function featureList($featureList) + { + return $this->setProperty('featureList', $featureList); + } + /** * Media type, typically MIME format (see [IANA * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of @@ -998,6 +843,21 @@ public function fileFormat($fileFormat) return $this->setProperty('fileFormat', $fileFormat); } + /** + * Size of the application / package (e.g. 18MB). In the absence of a unit + * (MB, KB etc.), KB will be assumed. + * + * @param string|string[] $fileSize + * + * @return static + * + * @see http://schema.org/fileSize + */ + public function fileSize($fileSize) + { + return $this->setProperty('fileSize', $fileSize); + } + /** * A person or organization that supports (sponsors) something through some * kind of financial contribution. @@ -1035,25 +895,58 @@ public function genre($genre) * * @return static * - * @see http://schema.org/hasPart + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier */ - public function hasPart($hasPart) + public function identifier($identifier) { - return $this->setProperty('hasPart', $hasPart); + return $this->setProperty('identifier', $identifier); } /** - * Headline of the article. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $headline + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/headline + * @see http://schema.org/image */ - public function headline($headline) + public function image($image) { - return $this->setProperty('headline', $headline); + return $this->setProperty('image', $image); } /** @@ -1073,6 +966,21 @@ public function inLanguage($inLanguage) return $this->setProperty('inLanguage', $inLanguage); } + /** + * URL at which the app may be installed, if different from the URL of the + * item. + * + * @param string|string[] $installUrl + * + * @return static + * + * @see http://schema.org/installUrl + */ + public function installUrl($installUrl) + { + return $this->setProperty('installUrl', $installUrl); + } + /** * The number of interactions for the CreativeWork using the WebSite or * SoftwareApplication. The most specific child type of InteractionCounter @@ -1253,6 +1161,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1268,6 +1192,20 @@ public function material($material) return $this->setProperty('material', $material); } + /** + * Minimum memory requirements. + * + * @param string|string[] $memoryRequirements + * + * @return static + * + * @see http://schema.org/memoryRequirements + */ + public function memoryRequirements($memoryRequirements) + { + return $this->setProperty('memoryRequirements', $memoryRequirements); + } + /** * Indicates that the CreativeWork contains a reference to, but is not * necessarily about a concept. @@ -1283,6 +1221,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1299,6 +1251,35 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). + * + * @param string|string[] $operatingSystem + * + * @return static + * + * @see http://schema.org/operatingSystem + */ + public function operatingSystem($operatingSystem) + { + return $this->setProperty('operatingSystem', $operatingSystem); + } + + /** + * Permission(s) required to run the app (for example, a mobile app may + * require full internet access or may run only on wifi). + * + * @param string|string[] $permissions + * + * @return static + * + * @see http://schema.org/permissions + */ + public function permissions($permissions) + { + return $this->setProperty('permissions', $permissions); + } + /** * The position of an item in a series or sequence of items. * @@ -1313,6 +1294,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Processor architecture required to run the application (e.g. IA64). + * + * @param string|string[] $processorRequirements + * + * @return static + * + * @see http://schema.org/processorRequirements + */ + public function processorRequirements($processorRequirements) + { + return $this->setProperty('processorRequirements', $processorRequirements); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1411,6 +1421,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * Description of what changed in this version. + * + * @param string|string[] $releaseNotes + * + * @return static + * + * @see http://schema.org/releaseNotes + */ + public function releaseNotes($releaseNotes) + { + return $this->setProperty('releaseNotes', $releaseNotes); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1426,6 +1450,23 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $requirements + * + * @return static + * + * @see http://schema.org/requirements + */ + public function requirements($requirements) + { + return $this->setProperty('requirements', $requirements); + } + /** * A review of the item. * @@ -1455,20 +1496,109 @@ public function reviews($reviews) } /** - * Indicates (by URL or string) a particular version of a schema used in - * some CreativeWork. For example, a document could declare a schemaVersion - * using an URL such as http://schema.org/version/2.0/ if precise indication - * of schema version was required by some application. + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * A link to a screenshot image of the app. + * + * @param ImageObject|ImageObject[]|string|string[] $screenshot + * + * @return static + * + * @see http://schema.org/screenshot + */ + public function screenshot($screenshot) + { + return $this->setProperty('screenshot', $screenshot); + } + + /** + * Additional content for a software application. + * + * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn + * + * @return static + * + * @see http://schema.org/softwareAddOn + */ + public function softwareAddOn($softwareAddOn) + { + return $this->setProperty('softwareAddOn', $softwareAddOn); + } + + /** + * Software application help. + * + * @param CreativeWork|CreativeWork[] $softwareHelp + * + * @return static + * + * @see http://schema.org/softwareHelp + */ + public function softwareHelp($softwareHelp) + { + return $this->setProperty('softwareHelp', $softwareHelp); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $softwareRequirements + * + * @return static + * + * @see http://schema.org/softwareRequirements + */ + public function softwareRequirements($softwareRequirements) + { + return $this->setProperty('softwareRequirements', $softwareRequirements); + } + + /** + * Version of the software instance. * - * @param string|string[] $schemaVersion + * @param string|string[] $softwareVersion * * @return static * - * @see http://schema.org/schemaVersion + * @see http://schema.org/softwareVersion */ - public function schemaVersion($schemaVersion) + public function softwareVersion($softwareVersion) { - return $this->setProperty('schemaVersion', $schemaVersion); + return $this->setProperty('softwareVersion', $softwareVersion); } /** @@ -1536,6 +1666,48 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * Storage requirements (free space required). + * + * @param string|string[] $storageRequirements + * + * @return static + * + * @see http://schema.org/storageRequirements + */ + public function storageRequirements($storageRequirements) + { + return $this->setProperty('storageRequirements', $storageRequirements); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Supporting data for a SoftwareApplication. + * + * @param DataFeed|DataFeed[] $supportingData + * + * @return static + * + * @see http://schema.org/supportingData + */ + public function supportingData($supportingData) + { + return $this->setProperty('supportingData', $supportingData); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1657,6 +1829,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1700,190 +1886,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MobilePhoneStore.php b/src/MobilePhoneStore.php index ef236ba5d..59b1b81f0 100644 --- a/src/MobilePhoneStore.php +++ b/src/MobilePhoneStore.php @@ -17,126 +17,104 @@ class MobilePhoneStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/MonetaryAmount.php b/src/MonetaryAmount.php index deffc93da..5763b7815 100644 --- a/src/MonetaryAmount.php +++ b/src/MonetaryAmount.php @@ -18,79 +18,6 @@ */ class MonetaryAmount extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { - /** - * The currency in which the monetary amount is expressed. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $currency - * - * @return static - * - * @see http://schema.org/currency - */ - public function currency($currency) - { - return $this->setProperty('currency', $currency); - } - - /** - * The upper value of some characteristic or property. - * - * @param float|float[]|int|int[] $maxValue - * - * @return static - * - * @see http://schema.org/maxValue - */ - public function maxValue($maxValue) - { - return $this->setProperty('maxValue', $maxValue); - } - - /** - * The lower value of some characteristic or property. - * - * @param float|float[]|int|int[] $minValue - * - * @return static - * - * @see http://schema.org/minValue - */ - public function minValue($minValue) - { - return $this->setProperty('minValue', $minValue); - } - - /** - * The value of the quantitative value or property value node. - * - * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type - * for values is 'Number'. - * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or - * 'StructuredValue'. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value - * - * @return static - * - * @see http://schema.org/value - */ - public function value($value) - { - return $this->setProperty('value', $value); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -124,6 +51,28 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The currency in which the monetary amount is expressed. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currency + * + * @return static + * + * @see http://schema.org/currency + */ + public function currency($currency) + { + return $this->setProperty('currency', $currency); + } + /** * A description of the item. * @@ -204,6 +153,34 @@ public function mainEntityOfPage($mainEntityOfPage) return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } + /** + * The upper value of some characteristic or property. + * + * @param float|float[]|int|int[] $maxValue + * + * @return static + * + * @see http://schema.org/maxValue + */ + public function maxValue($maxValue) + { + return $this->setProperty('maxValue', $maxValue); + } + + /** + * The lower value of some characteristic or property. + * + * @param float|float[]|int|int[] $minValue + * + * @return static + * + * @see http://schema.org/minValue + */ + public function minValue($minValue) + { + return $this->setProperty('minValue', $minValue); + } + /** * The name of the item. * @@ -277,4 +254,27 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The value of the quantitative value or property value node. + * + * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type + * for values is 'Number'. + * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or + * 'StructuredValue'. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value + * + * @return static + * + * @see http://schema.org/value + */ + public function value($value) + { + return $this->setProperty('value', $value); + } + } diff --git a/src/MonetaryAmountDistribution.php b/src/MonetaryAmountDistribution.php index f5e3afe47..5ec4fa98e 100644 --- a/src/MonetaryAmountDistribution.php +++ b/src/MonetaryAmountDistribution.php @@ -15,98 +15,6 @@ */ class MonetaryAmountDistribution extends BaseType implements QuantitativeValueDistributionContract, StructuredValueContract, IntangibleContract, ThingContract { - /** - * The currency in which the monetary amount is expressed. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $currency - * - * @return static - * - * @see http://schema.org/currency - */ - public function currency($currency) - { - return $this->setProperty('currency', $currency); - } - - /** - * The median value. - * - * @param float|float[]|int|int[] $median - * - * @return static - * - * @see http://schema.org/median - */ - public function median($median) - { - return $this->setProperty('median', $median); - } - - /** - * The 10th percentile value. - * - * @param float|float[]|int|int[] $percentile10 - * - * @return static - * - * @see http://schema.org/percentile10 - */ - public function percentile10($percentile10) - { - return $this->setProperty('percentile10', $percentile10); - } - - /** - * The 25th percentile value. - * - * @param float|float[]|int|int[] $percentile25 - * - * @return static - * - * @see http://schema.org/percentile25 - */ - public function percentile25($percentile25) - { - return $this->setProperty('percentile25', $percentile25); - } - - /** - * The 75th percentile value. - * - * @param float|float[]|int|int[] $percentile75 - * - * @return static - * - * @see http://schema.org/percentile75 - */ - public function percentile75($percentile75) - { - return $this->setProperty('percentile75', $percentile75); - } - - /** - * The 90th percentile value. - * - * @param float|float[]|int|int[] $percentile90 - * - * @return static - * - * @see http://schema.org/percentile90 - */ - public function percentile90($percentile90) - { - return $this->setProperty('percentile90', $percentile90); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -140,6 +48,28 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The currency in which the monetary amount is expressed. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currency + * + * @return static + * + * @see http://schema.org/currency + */ + public function currency($currency) + { + return $this->setProperty('currency', $currency); + } + /** * A description of the item. * @@ -220,6 +150,20 @@ public function mainEntityOfPage($mainEntityOfPage) return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } + /** + * The median value. + * + * @param float|float[]|int|int[] $median + * + * @return static + * + * @see http://schema.org/median + */ + public function median($median) + { + return $this->setProperty('median', $median); + } + /** * The name of the item. * @@ -234,6 +178,62 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The 10th percentile value. + * + * @param float|float[]|int|int[] $percentile10 + * + * @return static + * + * @see http://schema.org/percentile10 + */ + public function percentile10($percentile10) + { + return $this->setProperty('percentile10', $percentile10); + } + + /** + * The 25th percentile value. + * + * @param float|float[]|int|int[] $percentile25 + * + * @return static + * + * @see http://schema.org/percentile25 + */ + public function percentile25($percentile25) + { + return $this->setProperty('percentile25', $percentile25); + } + + /** + * The 75th percentile value. + * + * @param float|float[]|int|int[] $percentile75 + * + * @return static + * + * @see http://schema.org/percentile75 + */ + public function percentile75($percentile75) + { + return $this->setProperty('percentile75', $percentile75); + } + + /** + * The 90th percentile value. + * + * @param float|float[]|int|int[] $percentile90 + * + * @return static + * + * @see http://schema.org/percentile90 + */ + public function percentile90($percentile90) + { + return $this->setProperty('percentile90', $percentile90); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/Mosque.php b/src/Mosque.php index 745abb7f7..3b2a340b8 100644 --- a/src/Mosque.php +++ b/src/Mosque.php @@ -15,35 +15,6 @@ */ class Mosque extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Motel.php b/src/Motel.php index 8ef993330..0e646d937 100644 --- a/src/Motel.php +++ b/src/Motel.php @@ -20,352 +20,395 @@ class Motel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/additionalProperty */ - public function amenityFeature($amenityFeature) + public function additionalProperty($additionalProperty) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * An intended audience, i.e. a group for whom something was created. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Audience|Audience[] $audience + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/additionalType */ - public function audience($audience) + public function additionalType($additionalType) { - return $this->setProperty('audience', $audience); + return $this->setProperty('additionalType', $additionalType); } /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * Physical address of the item. * - * @param Language|Language[]|string|string[] $availableLanguage + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/availableLanguage + * @see http://schema.org/address */ - public function availableLanguage($availableLanguage) + public function address($address) { - return $this->setProperty('availableLanguage', $availableLanguage); + return $this->setProperty('address', $address); } /** - * The earliest someone may check into a lodging establishment. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/checkinTime + * @see http://schema.org/aggregateRating */ - public function checkinTime($checkinTime) + public function aggregateRating($aggregateRating) { - return $this->setProperty('checkinTime', $checkinTime); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The latest someone may check out of a lodging establishment. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/checkoutTime + * @see http://schema.org/alternateName */ - public function checkoutTime($checkoutTime) + public function alternateName($alternateName) { - return $this->setProperty('checkoutTime', $checkoutTime); + return $this->setProperty('alternateName', $alternateName); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/amenityFeature */ - public function numberOfRooms($numberOfRooms) + public function amenityFeature($amenityFeature) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * The geographic area where a service or offered item is provided. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/areaServed */ - public function petsAllowed($petsAllowed) + public function areaServed($areaServed) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('areaServed', $areaServed); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * An intended audience, i.e. a group for whom something was created. * - * @param Rating|Rating[] $starRating + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/audience */ - public function starRating($starRating) + public function audience($audience) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('audience', $audience); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] * - * @param Organization|Organization[] $branchOf + * @param Language|Language[]|string|string[] $availableLanguage * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/availableLanguage */ - public function branchOf($branchOf) + public function availableLanguage($availableLanguage) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('availableLanguage', $availableLanguage); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An award won by or for this item. * - * @param string|string[] $currenciesAccepted + * @param string|string[] $award * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/award */ - public function currenciesAccepted($currenciesAccepted) + public function award($award) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('award', $award); } /** - * 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 '-'. + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * The earliest someone may check into a lodging establishment. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime * * @return static * - * @see http://schema.org/address + * @see http://schema.org/checkinTime */ - public function address($address) + public function checkinTime($checkinTime) { - return $this->setProperty('address', $address); + return $this->setProperty('checkinTime', $checkinTime); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The latest someone may check out of a lodging establishment. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/checkoutTime */ - public function aggregateRating($aggregateRating) + public function checkoutTime($checkoutTime) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('checkoutTime', $checkoutTime); } /** - * The geographic area where a service or offered item is provided. + * A contact point for a person or organization. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/contactPoint */ - public function areaServed($areaServed) + public function contactPoint($contactPoint) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('contactPoint', $contactPoint); } /** - * An award won by or for this item. + * A contact point for a person or organization. * - * @param string|string[] $award + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/award + * @see http://schema.org/contactPoints */ - public function award($award) + public function contactPoints($contactPoints) { - return $this->setProperty('award', $award); + return $this->setProperty('contactPoints', $contactPoints); } /** - * Awards won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $awards + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containedIn */ - public function awards($awards) + public function containedIn($containedIn) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containedIn', $containedIn); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The basic containment relation between a place and one that contains it. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/containedInPlace */ - public function brand($brand) + public function containedInPlace($containedInPlace) { - return $this->setProperty('brand', $brand); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A contact point for a person or organization. + * The basic containment relation between a place and another that it + * contains. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -553,6 +596,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -570,6 +627,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -600,851 +671,780 @@ public function hasPOS($hasPOS) } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. - * - * @param string|string[] $isicV4 - * - * @return static - * - * @see http://schema.org/isicV4 - */ - public function isicV4($isicV4) - { - return $this->setProperty('isicV4', $isicV4); - } - - /** - * The official name of the organization, e.g. the registered company name. - * - * @param string|string[] $legalName - * - * @return static - * - * @see http://schema.org/legalName - */ - public function legalName($legalName) - { - return $this->setProperty('legalName', $legalName); - } - - /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. - * - * @param string|string[] $leiCode - * - * @return static - * - * @see http://schema.org/leiCode - */ - public function leiCode($leiCode) - { - return $this->setProperty('leiCode', $leiCode); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * An associated logo. - * - * @param ImageObject|ImageObject[]|string|string[] $logo - * - * @return static - * - * @see http://schema.org/logo - */ - public function logo($logo) - { - return $this->setProperty('logo', $logo); - } - - /** - * A pointer to products or services offered by the organization or person. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $makesOffer + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/identifier */ - public function makesOffer($makesOffer) + public function identifier($identifier) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('identifier', $identifier); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $member + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/member + * @see http://schema.org/image */ - public function member($member) + public function image($image) { - return $this->setProperty('member', $member); + return $this->setProperty('image', $image); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/isAccessibleForFree */ - public function memberOf($memberOf) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * A member of this organization. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param Organization|Organization[]|Person|Person[] $members + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isicV4 */ - public function members($members) + public function isicV4($isicV4) { - return $this->setProperty('members', $members); + return $this->setProperty('isicV4', $isicV4); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $naics + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/latitude */ - public function naics($naics) + public function latitude($latitude) { - return $this->setProperty('naics', $naics); + return $this->setProperty('latitude', $latitude); } /** - * The number of employees in an organization e.g. business. + * The official name of the organization, e.g. the registered company name. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/legalName */ - public function numberOfEmployees($numberOfEmployees) + public function legalName($legalName) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('legalName', $legalName); } /** - * A pointer to the organization or person making the offer. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/leiCode */ - public function offeredBy($offeredBy) + public function leiCode($leiCode) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('leiCode', $leiCode); } /** - * Products owned by the organization or person. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/location */ - public function owns($owns) + public function location($location) { - return $this->setProperty('owns', $owns); + return $this->setProperty('location', $location); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * An associated logo. * - * @param Organization|Organization[] $parentOrganization + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/logo */ - public function parentOrganization($parentOrganization) + public function logo($logo) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('logo', $logo); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/longitude */ - public function publishingPrinciples($publishingPrinciples) + public function longitude($longitude) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('longitude', $longitude); } /** - * A review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $review + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/review + * @see http://schema.org/mainEntityOfPage */ - public function review($review) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('review', $review); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Review of the item. + * A pointer to products or services offered by the organization or person. * - * @param Review|Review[] $reviews + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/makesOffer */ - public function reviews($reviews) + public function makesOffer($makesOffer) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A URL to a map of the place. * - * @param Demand|Demand[] $seeks + * @param string|string[] $map * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/map */ - public function seeks($seeks) + public function map($map) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('map', $map); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $maps * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/maps */ - public function serviceArea($serviceArea) + public function maps($maps) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('maps', $maps); } /** - * A slogan or motto associated with the item. + * The total number of individuals that may attend an event or venue. * - * @param string|string[] $slogan + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maximumAttendeeCapacity */ - public function slogan($slogan) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * 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. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/member */ - public function sponsor($sponsor) + public function member($member) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('member', $member); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/memberOf */ - public function subOrganization($subOrganization) + public function memberOf($memberOf) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('memberOf', $memberOf); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * A member of this organization. * - * @param string|string[] $taxID + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/members */ - public function taxID($taxID) + public function members($members) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('members', $members); } /** - * The telephone number. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $telephone + * @param string|string[] $naics * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/naics */ - public function telephone($telephone) + public function naics($naics) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('naics', $naics); } /** - * The Value-added Tax ID of the organization or person. + * The name of the item. * - * @param string|string[] $vatID + * @param string|string[] $name * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/name */ - public function vatID($vatID) + public function name($name) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The number of employees in an organization e.g. business. * - * @param string|string[] $additionalType + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/numberOfEmployees */ - public function additionalType($additionalType) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * An alias for the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param string|string[] $alternateName + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/numberOfRooms */ - public function alternateName($alternateName) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A description of the item. + * A pointer to the organization or person making the offer. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/description + * @see http://schema.org/offeredBy */ - public function description($description) + public function offeredBy($offeredBy) { - return $this->setProperty('description', $description); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/openingHours */ - public function disambiguatingDescription($disambiguatingDescription) + public function openingHours($openingHours) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('openingHours', $openingHours); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The opening hours of a certain place. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHoursSpecification */ - public function identifier($identifier) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Products owned by the organization or person. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/image + * @see http://schema.org/owns */ - public function image($image) + public function owns($owns) { - return $this->setProperty('image', $image); + return $this->setProperty('owns', $owns); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/parentOrganization */ - public function mainEntityOfPage($mainEntityOfPage) + public function parentOrganization($parentOrganization) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The name of the item. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $name + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/name + * @see http://schema.org/paymentAccepted */ - public function name($name) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('name', $name); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param Action|Action[] $potentialAction + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/petsAllowed */ - public function potentialAction($potentialAction) + public function petsAllowed($petsAllowed) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $branchCode + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publicAccess */ - public function branchCode($branchCode) + public function publicAccess($publicAccess) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedIn + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publishingPrinciples */ - public function containedIn($containedIn) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/review */ - public function containedInPlace($containedInPlace) + public function review($review) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and another that it - * contains. + * Review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/reviews */ - public function containsPlace($containsPlace) + public function reviews($reviews) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('reviews', $reviews); } /** - * The geo coordinates of the place. + * 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. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/sameAs */ - public function geo($geo) + public function sameAs($sameAs) { - return $this->setProperty('geo', $geo); + return $this->setProperty('sameAs', $sameAs); } /** - * A URL to a map of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param Map|Map[]|string|string[] $hasMap + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/seeks */ - public function hasMap($hasMap) + public function seeks($seeks) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('seeks', $seeks); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/MotorcycleDealer.php b/src/MotorcycleDealer.php index cdce18db9..045198aaf 100644 --- a/src/MotorcycleDealer.php +++ b/src/MotorcycleDealer.php @@ -17,126 +17,104 @@ class MotorcycleDealer extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/MotorcycleRepair.php b/src/MotorcycleRepair.php index 51c290cb4..bc7e8235d 100644 --- a/src/MotorcycleRepair.php +++ b/src/MotorcycleRepair.php @@ -17,126 +17,104 @@ class MotorcycleRepair extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Mountain.php b/src/Mountain.php index 176b5b18b..58ce81e7b 100644 --- a/src/Mountain.php +++ b/src/Mountain.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/MoveAction.php b/src/MoveAction.php index 749828766..edd112502 100644 --- a/src/MoveAction.php +++ b/src/MoveAction.php @@ -19,62 +19,96 @@ class MoveAction extends BaseType implements ActionContract, ThingContract { /** - * A sub property of location. The original location of the object or the - * agent before the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $fromLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/actionStatus */ - public function fromLocation($fromLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $toLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/additionalType */ - public function toLocation($toLocation) + public function additionalType($additionalType) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -115,288 +149,254 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Thing|Thing[] $object + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/object + * @see http://schema.org/fromLocation */ - public function object($object) + public function fromLocation($fromLocation) { - return $this->setProperty('object', $object); + return $this->setProperty('fromLocation', $fromLocation); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/Movie.php b/src/Movie.php index d26aeb5d9..1392681da 100644 --- a/src/Movie.php +++ b/src/Movie.php @@ -13,156 +13,6 @@ */ class Movie extends BaseType implements CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * The country of the principal offices of the production company or - * individual responsible for the movie or program. - * - * @param Country|Country[] $countryOfOrigin - * - * @return static - * - * @see http://schema.org/countryOfOrigin - */ - public function countryOfOrigin($countryOfOrigin) - { - return $this->setProperty('countryOfOrigin', $countryOfOrigin); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * Languages in which subtitles/captions are available, in [IETF BCP 47 - * standard format](http://tools.ietf.org/html/bcp47). - * - * @param Language|Language[]|string|string[] $subtitleLanguage - * - * @return static - * - * @see http://schema.org/subtitleLanguage - */ - public function subtitleLanguage($subtitleLanguage) - { - return $this->setProperty('subtitleLanguage', $subtitleLanguage); - } - - /** - * The trailer of a movie or tv/radio series, season, episode, etc. - * - * @param VideoObject|VideoObject[] $trailer - * - * @return static - * - * @see http://schema.org/trailer - */ - public function trailer($trailer) - { - return $this->setProperty('trailer', $trailer); - } - /** * The subject matter of the content. * @@ -307,6 +157,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -322,6 +222,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -554,6 +468,21 @@ public function copyrightYear($copyrightYear) return $this->setProperty('copyrightYear', $copyrightYear); } + /** + * The country of the principal offices of the production company or + * individual responsible for the movie or program. + * + * @param Country|Country[] $countryOfOrigin + * + * @return static + * + * @see http://schema.org/countryOfOrigin + */ + public function countryOfOrigin($countryOfOrigin) + { + return $this->setProperty('countryOfOrigin', $countryOfOrigin); + } + /** * The creator/author of this CreativeWork. This is the same as the Author * property for CreativeWork. @@ -614,37 +543,114 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment * * @return static * @@ -838,6 +844,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1035,6 +1074,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1065,6 +1120,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1095,6 +1178,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1110,6 +1208,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1236,6 +1349,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1318,6 +1447,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Languages in which subtitles/captions are available, in [IETF BCP 47 + * standard format](http://tools.ietf.org/html/bcp47). + * + * @param Language|Language[]|string|string[] $subtitleLanguage + * + * @return static + * + * @see http://schema.org/subtitleLanguage + */ + public function subtitleLanguage($subtitleLanguage) + { + return $this->setProperty('subtitleLanguage', $subtitleLanguage); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1409,6 +1567,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1439,6 +1611,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1482,190 +1668,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MovieClip.php b/src/MovieClip.php index 5815a147d..04d639fa2 100644 --- a/src/MovieClip.php +++ b/src/MovieClip.php @@ -14,138 +14,6 @@ */ class MovieClip extends BaseType implements ClipContract, CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * Position of the clip within an ordered group of clips. - * - * @param int|int[]|string|string[] $clipNumber - * - * @return static - * - * @see http://schema.org/clipNumber - */ - public function clipNumber($clipNumber) - { - return $this->setProperty('clipNumber', $clipNumber); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The episode to which this clip belongs. - * - * @param Episode|Episode[] $partOfEpisode - * - * @return static - * - * @see http://schema.org/partOfEpisode - */ - public function partOfEpisode($partOfEpisode) - { - return $this->setProperty('partOfEpisode', $partOfEpisode); - } - - /** - * The season to which this episode belongs. - * - * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason - * - * @return static - * - * @see http://schema.org/partOfSeason - */ - public function partOfSeason($partOfSeason) - { - return $this->setProperty('partOfSeason', $partOfSeason); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - /** * The subject matter of the content. * @@ -290,6 +158,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -305,6 +223,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -435,6 +367,20 @@ public function citation($citation) return $this->setProperty('citation', $citation); } + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + /** * Comments, typically from users. * @@ -597,60 +543,122 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * 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. * - * @param string|string[] $educationalUse + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/disambiguatingDescription */ - public function educationalUse($educationalUse) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); } /** @@ -821,6 +829,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1018,6 +1059,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1048,6 +1105,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1064,6 +1149,48 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1078,6 +1205,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1219,6 +1361,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1301,6 +1459,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1422,6 +1594,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1465,190 +1651,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MovieRentalStore.php b/src/MovieRentalStore.php index 476465f45..b44940221 100644 --- a/src/MovieRentalStore.php +++ b/src/MovieRentalStore.php @@ -17,126 +17,104 @@ class MovieRentalStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/MovieSeries.php b/src/MovieSeries.php index da8ffc70f..67d0dfb6f 100644 --- a/src/MovieSeries.php +++ b/src/MovieSeries.php @@ -17,141 +17,6 @@ */ class MovieSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The trailer of a movie or tv/radio series, season, episode, etc. - * - * @param VideoObject|VideoObject[] $trailer - * - * @return static - * - * @see http://schema.org/trailer - */ - public function trailer($trailer) - { - return $this->setProperty('trailer', $trailer); - } - - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - /** * The subject matter of the content. * @@ -296,6 +161,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -311,6 +226,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -603,75 +532,137 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * 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. * - * @param string|string[] $educationalUse + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/disambiguatingDescription */ - public function educationalUse($educationalUse) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A media object that encodes this CreativeWork. This property is a synonym - * for associatedMedia. + * A link to the page containing the comments of the CreativeWork. * - * @param MediaObject|MediaObject[] $encoding + * @param string|string[] $discussionUrl * * @return static * - * @see http://schema.org/encoding + * @see http://schema.org/discussionUrl */ - public function encoding($encoding) + public function discussionUrl($discussionUrl) { - return $this->setProperty('encoding', $encoding); + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); } /** @@ -715,6 +706,21 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -827,6 +833,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -949,6 +988,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1024,6 +1079,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1054,6 +1125,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1084,6 +1183,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1099,6 +1213,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1225,6 +1354,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1307,6 +1452,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1398,6 +1572,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1428,6 +1616,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1471,206 +1673,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - } diff --git a/src/MovieTheater.php b/src/MovieTheater.php index e8703e4a0..1428ce3d4 100644 --- a/src/MovieTheater.php +++ b/src/MovieTheater.php @@ -17,49 +17,6 @@ */ class MovieTheater extends BaseType implements CivicStructureContract, EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { - /** - * The number of screens in the movie theater. - * - * @param float|float[]|int|int[] $screenCount - * - * @return static - * - * @see http://schema.org/screenCount - */ - public function screenCount($screenCount) - { - return $this->setProperty('screenCount', $screenCount); - } - - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -82,6 +39,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -111,6 +87,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -129,479 +119,495 @@ public function amenityFeature($amenityFeature) } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The geographic area where a service or offered item is provided. * - * @param string|string[] $branchCode + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/areaServed */ - public function branchCode($branchCode) + public function areaServed($areaServed) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('areaServed', $areaServed); } /** - * The basic containment relation between a place and one that contains it. + * An award won by or for this item. * - * @param Place|Place[] $containedIn + * @param string|string[] $award * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/award */ - public function containedIn($containedIn) + public function award($award) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('award', $award); } /** - * The basic containment relation between a place and one that contains it. + * Awards won by or for this item. * - * @param Place|Place[] $containedInPlace + * @param string|string[] $awards * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/awards */ - public function containedInPlace($containedInPlace) + public function awards($awards) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('awards', $awards); } /** - * The basic containment relation between a place and another that it - * contains. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/branchCode */ - public function containsPlace($containsPlace) + public function branchCode($branchCode) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('branchCode', $branchCode); } /** - * Upcoming or past event associated with this place, organization, or - * action. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param Event|Event[] $event + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/event + * @see http://schema.org/branchOf */ - public function event($event) + public function branchOf($branchOf) { - return $this->setProperty('event', $event); + return $this->setProperty('branchOf', $branchOf); } /** - * Upcoming or past events associated with this place or organization. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param Event|Event[] $events + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/events + * @see http://schema.org/brand */ - public function events($events) + public function brand($brand) { - return $this->setProperty('events', $events); + return $this->setProperty('brand', $brand); } /** - * The fax number. + * A contact point for a person or organization. * - * @param string|string[] $faxNumber + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/faxNumber + * @see http://schema.org/contactPoint */ - public function faxNumber($faxNumber) + public function contactPoint($contactPoint) { - return $this->setProperty('faxNumber', $faxNumber); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The geo coordinates of the place. + * A contact point for a person or organization. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/contactPoints */ - public function geo($geo) + public function contactPoints($contactPoints) { - return $this->setProperty('geo', $geo); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $globalLocationNumber + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/containedIn */ - public function globalLocationNumber($globalLocationNumber) + public function containedIn($containedIn) { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); + return $this->setProperty('containedIn', $containedIn); } /** - * A URL to a map of the place. + * The basic containment relation between a place and one that contains it. * - * @param Map|Map[]|string|string[] $hasMap + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/containedInPlace */ - public function hasMap($hasMap) + public function containedInPlace($containedInPlace) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The basic containment relation between a place and another that it + * contains. * - * @param bool|bool[] $isAccessibleForFree + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/containsPlace */ - public function isAccessibleForFree($isAccessibleForFree) + public function containsPlace($containsPlace) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $isicV4 + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/currenciesAccepted */ - public function isicV4($isicV4) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/department */ - public function latitude($latitude) + public function department($department) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('department', $department); } /** - * An associated logo. + * A description of the item. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param string|string[] $description * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/description */ - public function logo($logo) + public function description($description) { - return $this->setProperty('logo', $logo); + return $this->setProperty('description', $description); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * 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. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/disambiguatingDescription */ - public function longitude($longitude) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A URL to a map of the place. + * The date that this organization was dissolved. * - * @param string|string[] $map + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate * * @return static * - * @see http://schema.org/map + * @see http://schema.org/dissolutionDate */ - public function map($map) + public function dissolutionDate($dissolutionDate) { - return $this->setProperty('map', $map); + return $this->setProperty('dissolutionDate', $dissolutionDate); } /** - * A URL to a map of the place. + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. * - * @param string|string[] $maps + * @param string|string[] $duns * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/duns */ - public function maps($maps) + public function duns($duns) { - return $this->setProperty('maps', $maps); + return $this->setProperty('duns', $duns); } /** - * The total number of individuals that may attend an event or venue. + * Email address. * - * @param int|int[] $maximumAttendeeCapacity + * @param string|string[] $email * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/email */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function email($email) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('email', $email); } /** - * The opening hours of a certain place. + * Someone working for this organization. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Person|Person[] $employee * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/employee */ - public function openingHoursSpecification($openingHoursSpecification) + public function employee($employee) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('employee', $employee); } /** - * A photograph of this place. + * People working for this organization. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param Person|Person[] $employees * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/employees */ - public function photo($photo) + public function employees($employees) { - return $this->setProperty('photo', $photo); + return $this->setProperty('employees', $employees); } /** - * Photographs of this place. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/event */ - public function photos($photos) + public function event($event) { - return $this->setProperty('photos', $photos); + return $this->setProperty('event', $event); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * Upcoming or past events associated with this place or organization. * - * @param bool|bool[] $publicAccess + * @param Event|Event[] $events * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/events */ - public function publicAccess($publicAccess) + public function events($events) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('events', $events); } /** - * A review of the item. + * The fax number. * - * @param Review|Review[] $review + * @param string|string[] $faxNumber * * @return static * - * @see http://schema.org/review + * @see http://schema.org/faxNumber */ - public function review($review) + public function faxNumber($faxNumber) { - return $this->setProperty('review', $review); + return $this->setProperty('faxNumber', $faxNumber); } /** - * Review of the item. + * A person who founded this organization. * - * @param Review|Review[] $reviews + * @param Person|Person[] $founder * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/founder */ - public function reviews($reviews) + public function founder($founder) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('founder', $founder); } /** - * A slogan or motto associated with the item. + * A person who founded this organization. * - * @param string|string[] $slogan + * @param Person|Person[] $founders * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/founders */ - public function slogan($slogan) + public function founders($founders) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('founders', $founders); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * The date that this organization was founded. * - * @param bool|bool[] $smokingAllowed + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/foundingDate */ - public function smokingAllowed($smokingAllowed) + public function foundingDate($foundingDate) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('foundingDate', $foundingDate); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The place where the Organization was founded. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param Place|Place[] $foundingLocation * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/foundingLocation */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function foundingLocation($foundingLocation) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('foundingLocation', $foundingLocation); } /** - * The telephone number. + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $funder * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/funder */ - public function telephone($telephone) + public function funder($funder) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('funder', $funder); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geo coordinates of the place. * - * @param string|string[] $additionalType + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/geo */ - public function additionalType($additionalType) + public function geo($geo) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('geo', $geo); } /** - * An alias for the item. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $alternateName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/globalLocationNumber */ - public function alternateName($alternateName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * A description of the item. + * A URL to a map of the place. * - * @param string|string[] $description + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/description + * @see http://schema.org/hasMap */ - public function description($description) + public function hasMap($hasMap) { - return $this->setProperty('description', $description); + return $this->setProperty('hasMap', $hasMap); } /** - * 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. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param string|string[] $disambiguatingDescription + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/hasOfferCatalog */ - public function disambiguatingDescription($disambiguatingDescription) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); } /** @@ -638,657 +644,609 @@ public function image($image) } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A flag to signal that the item, event, or place is accessible for free. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/isAccessibleForFree */ - public function mainEntityOfPage($mainEntityOfPage) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The name of the item. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $name + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/name + * @see http://schema.org/isicV4 */ - public function name($name) + public function isicV4($isicV4) { - return $this->setProperty('name', $name); + return $this->setProperty('isicV4', $isicV4); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/latitude */ - public function potentialAction($potentialAction) + public function latitude($latitude) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('latitude', $latitude); } /** - * 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. + * The official name of the organization, e.g. the registered company name. * - * @param string|string[] $sameAs + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/legalName */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $currenciesAccepted - * - * @return static - * - * @see http://schema.org/currenciesAccepted - */ - public function currenciesAccepted($currenciesAccepted) + public function legalName($legalName) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('legalName', $legalName); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param string|string[] $paymentAccepted + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/leiCode */ - public function paymentAccepted($paymentAccepted) + public function leiCode($leiCode) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('leiCode', $leiCode); } /** - * The price range of the business, for example ```$$$```. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $priceRange + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/location */ - public function priceRange($priceRange) + public function location($location) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('location', $location); } /** - * The geographic area where a service or offered item is provided. + * An associated logo. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/logo */ - public function areaServed($areaServed) + public function logo($logo) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('logo', $logo); } /** - * An award won by or for this item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $award + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/award + * @see http://schema.org/longitude */ - public function award($award) + public function longitude($longitude) { - return $this->setProperty('award', $award); + return $this->setProperty('longitude', $longitude); } /** - * Awards won by or for this item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $awards + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/mainEntityOfPage */ - public function awards($awards) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('awards', $awards); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * A pointer to products or services offered by the organization or person. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/makesOffer */ - public function brand($brand) + public function makesOffer($makesOffer) { - return $this->setProperty('brand', $brand); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A contact point for a person or organization. + * A URL to a map of the place. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param string|string[] $map * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/map */ - public function contactPoint($contactPoint) + public function map($map) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('map', $map); } /** - * A contact point for a person or organization. + * A URL to a map of the place. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $maps * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/maps */ - public function contactPoints($contactPoints) + public function maps($maps) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('maps', $maps); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[] $department + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/department + * @see http://schema.org/maximumAttendeeCapacity */ - public function department($department) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('department', $department); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * The date that this organization was dissolved. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/dissolutionDate + * @see http://schema.org/member */ - public function dissolutionDate($dissolutionDate) + public function member($member) { - return $this->setProperty('dissolutionDate', $dissolutionDate); + return $this->setProperty('member', $member); } /** - * The Dun & Bradstreet DUNS number for identifying an organization or - * business person. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $duns + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/duns + * @see http://schema.org/memberOf */ - public function duns($duns) + public function memberOf($memberOf) { - return $this->setProperty('duns', $duns); + return $this->setProperty('memberOf', $memberOf); } /** - * Email address. + * A member of this organization. * - * @param string|string[] $email + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/email + * @see http://schema.org/members */ - public function email($email) + public function members($members) { - return $this->setProperty('email', $email); + return $this->setProperty('members', $members); } /** - * Someone working for this organization. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param Person|Person[] $employee + * @param string|string[] $naics * * @return static * - * @see http://schema.org/employee + * @see http://schema.org/naics */ - public function employee($employee) + public function naics($naics) { - return $this->setProperty('employee', $employee); + return $this->setProperty('naics', $naics); } /** - * People working for this organization. + * The name of the item. * - * @param Person|Person[] $employees + * @param string|string[] $name * * @return static * - * @see http://schema.org/employees + * @see http://schema.org/name */ - public function employees($employees) + public function name($name) { - return $this->setProperty('employees', $employees); + return $this->setProperty('name', $name); } /** - * A person who founded this organization. + * The number of employees in an organization e.g. business. * - * @param Person|Person[] $founder + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/founder + * @see http://schema.org/numberOfEmployees */ - public function founder($founder) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('founder', $founder); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * A person who founded this organization. + * A pointer to the organization or person making the offer. * - * @param Person|Person[] $founders + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/founders + * @see http://schema.org/offeredBy */ - public function founders($founders) + public function offeredBy($offeredBy) { - return $this->setProperty('founders', $founders); + return $this->setProperty('offeredBy', $offeredBy); } /** - * The date that this organization was founded. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/foundingDate + * @see http://schema.org/openingHours */ - public function foundingDate($foundingDate) + public function openingHours($openingHours) { - return $this->setProperty('foundingDate', $foundingDate); + return $this->setProperty('openingHours', $openingHours); } /** - * The place where the Organization was founded. + * The opening hours of a certain place. * - * @param Place|Place[] $foundingLocation + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/foundingLocation + * @see http://schema.org/openingHoursSpecification */ - public function foundingLocation($foundingLocation) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('foundingLocation', $foundingLocation); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * A person or organization that supports (sponsors) something through some - * kind of financial contribution. + * Products owned by the organization or person. * - * @param Organization|Organization[]|Person|Person[] $funder + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/funder + * @see http://schema.org/owns */ - public function funder($funder) + public function owns($owns) { - return $this->setProperty('funder', $funder); + return $this->setProperty('owns', $owns); } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/parentOrganization */ - public function hasOfferCatalog($hasOfferCatalog) + public function parentOrganization($parentOrganization) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Points-of-Sales operated by the organization or person. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Place|Place[] $hasPOS + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/hasPOS + * @see http://schema.org/paymentAccepted */ - public function hasPOS($hasPOS) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('hasPOS', $hasPOS); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * The official name of the organization, e.g. the registered company name. + * A photograph of this place. * - * @param string|string[] $legalName + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/photo */ - public function legalName($legalName) + public function photo($photo) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('photo', $photo); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * Photographs of this place. * - * @param string|string[] $leiCode + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/photos */ - public function leiCode($leiCode) + public function photos($photos) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('photos', $photos); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/location + * @see http://schema.org/potentialAction */ - public function location($location) + public function potentialAction($potentialAction) { - return $this->setProperty('location', $location); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A pointer to products or services offered by the organization or person. + * The price range of the business, for example ```$$$```. * - * @param Offer|Offer[] $makesOffer + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/priceRange */ - public function makesOffer($makesOffer) + public function priceRange($priceRange) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('priceRange', $priceRange); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Organization|Organization[]|Person|Person[] $member + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/member + * @see http://schema.org/publicAccess */ - public function member($member) + public function publicAccess($publicAccess) { - return $this->setProperty('member', $member); + return $this->setProperty('publicAccess', $publicAccess); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/publishingPrinciples */ - public function memberOf($memberOf) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * A member of this organization. + * A review of the item. * - * @param Organization|Organization[]|Person|Person[] $members + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/members + * @see http://schema.org/review */ - public function members($members) + public function review($review) { - return $this->setProperty('members', $members); + return $this->setProperty('review', $review); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * Review of the item. * - * @param string|string[] $naics + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/reviews */ - public function naics($naics) + public function reviews($reviews) { - return $this->setProperty('naics', $naics); + return $this->setProperty('reviews', $reviews); } /** - * The number of employees in an organization e.g. business. + * 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. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/sameAs */ - public function numberOfEmployees($numberOfEmployees) + public function sameAs($sameAs) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('sameAs', $sameAs); } /** - * A pointer to the organization or person making the offer. + * The number of screens in the movie theater. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param float|float[]|int|int[] $screenCount * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/screenCount */ - public function offeredBy($offeredBy) + public function screenCount($screenCount) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('screenCount', $screenCount); } /** - * Products owned by the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/seeks */ - public function owns($owns) + public function seeks($seeks) { - return $this->setProperty('owns', $owns); + return $this->setProperty('seeks', $seeks); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The geographic area where the service is provided. * - * @param Organization|Organization[] $parentOrganization + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/serviceArea */ - public function parentOrganization($parentOrganization) + public function serviceArea($serviceArea) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('serviceArea', $serviceArea); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/slogan */ - public function publishingPrinciples($publishingPrinciples) + public function slogan($slogan) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('slogan', $slogan); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param Demand|Demand[] $seeks + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/smokingAllowed */ - public function seeks($seeks) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * The geographic area where the service is provided. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/specialOpeningHoursSpecification */ - public function serviceArea($serviceArea) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** @@ -1323,6 +1281,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -1338,6 +1310,34 @@ public function taxID($taxID) return $this->setProperty('taxID', $taxID); } + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The Value-added Tax ID of the organization or person. * diff --git a/src/MovingCompany.php b/src/MovingCompany.php index 197fec8e8..e1e2b522e 100644 --- a/src/MovingCompany.php +++ b/src/MovingCompany.php @@ -17,126 +17,104 @@ class MovingCompany extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Museum.php b/src/Museum.php index 64dbde6e4..f12bd64ee 100644 --- a/src/Museum.php +++ b/src/Museum.php @@ -14,35 +14,6 @@ */ class Museum extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/MusicAlbum.php b/src/MusicAlbum.php index a6e06634a..239716fc7 100644 --- a/src/MusicAlbum.php +++ b/src/MusicAlbum.php @@ -14,106 +14,6 @@ */ class MusicAlbum extends BaseType implements MusicPlaylistContract, CreativeWorkContract, ThingContract { - /** - * Classification of the album by it's type of content: soundtrack, live - * album, studio album, etc. - * - * @param MusicAlbumProductionType|MusicAlbumProductionType[] $albumProductionType - * - * @return static - * - * @see http://schema.org/albumProductionType - */ - public function albumProductionType($albumProductionType) - { - return $this->setProperty('albumProductionType', $albumProductionType); - } - - /** - * A release of this album. - * - * @param MusicRelease|MusicRelease[] $albumRelease - * - * @return static - * - * @see http://schema.org/albumRelease - */ - public function albumRelease($albumRelease) - { - return $this->setProperty('albumRelease', $albumRelease); - } - - /** - * The kind of release which this album is: single, EP or album. - * - * @param MusicAlbumReleaseType|MusicAlbumReleaseType[] $albumReleaseType - * - * @return static - * - * @see http://schema.org/albumReleaseType - */ - public function albumReleaseType($albumReleaseType) - { - return $this->setProperty('albumReleaseType', $albumReleaseType); - } - - /** - * The artist that performed this album or recording. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $byArtist - * - * @return static - * - * @see http://schema.org/byArtist - */ - public function byArtist($byArtist) - { - return $this->setProperty('byArtist', $byArtist); - } - - /** - * The number of tracks in this album or playlist. - * - * @param int|int[] $numTracks - * - * @return static - * - * @see http://schema.org/numTracks - */ - public function numTracks($numTracks) - { - return $this->setProperty('numTracks', $numTracks); - } - - /** - * A music recording (track)—usually a single song. If an ItemList is - * given, the list should contain items of type MusicRecording. - * - * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track - * - * @return static - * - * @see http://schema.org/track - */ - public function track($track) - { - return $this->setProperty('track', $track); - } - - /** - * A music recording (track)—usually a single song. - * - * @param MusicRecording|MusicRecording[] $tracks - * - * @return static - * - * @see http://schema.org/tracks - */ - public function tracks($tracks) - { - return $this->setProperty('tracks', $tracks); - } - /** * The subject matter of the content. * @@ -258,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -273,6 +192,63 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * Classification of the album by it's type of content: soundtrack, live + * album, studio album, etc. + * + * @param MusicAlbumProductionType|MusicAlbumProductionType[] $albumProductionType + * + * @return static + * + * @see http://schema.org/albumProductionType + */ + public function albumProductionType($albumProductionType) + { + return $this->setProperty('albumProductionType', $albumProductionType); + } + + /** + * A release of this album. + * + * @param MusicRelease|MusicRelease[] $albumRelease + * + * @return static + * + * @see http://schema.org/albumRelease + */ + public function albumRelease($albumRelease) + { + return $this->setProperty('albumRelease', $albumRelease); + } + + /** + * The kind of release which this album is: single, EP or album. + * + * @param MusicAlbumReleaseType|MusicAlbumReleaseType[] $albumReleaseType + * + * @return static + * + * @see http://schema.org/albumReleaseType + */ + public function albumReleaseType($albumReleaseType) + { + return $this->setProperty('albumReleaseType', $albumReleaseType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -374,6 +350,20 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The artist that performed this album or recording. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $byArtist + * + * @return static + * + * @see http://schema.org/byArtist + */ + public function byArtist($byArtist) + { + return $this->setProperty('byArtist', $byArtist); + } + /** * Fictional person connected with a creative work. * @@ -564,6 +554,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -789,6 +810,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -987,8 +1041,24 @@ public function mainEntity($mainEntity) } /** - * A material that something is made from, e.g. leather, wool, cotton, - * paper. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. * * @param Product|Product[]|string|string[] $material * @@ -1016,6 +1086,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of tracks in this album or playlist. + * + * @param int|int[] $numTracks + * + * @return static + * + * @see http://schema.org/numTracks + */ + public function numTracks($numTracks) + { + return $this->setProperty('numTracks', $numTracks); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1046,6 +1144,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1187,6 +1300,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1269,6 +1398,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1360,6 +1503,35 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * A music recording (track)—usually a single song. If an ItemList is + * given, the list should contain items of type MusicRecording. + * + * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track + * + * @return static + * + * @see http://schema.org/track + */ + public function track($track) + { + return $this->setProperty('track', $track); + } + + /** + * A music recording (track)—usually a single song. + * + * @param MusicRecording|MusicRecording[] $tracks + * + * @return static + * + * @see http://schema.org/tracks + */ + public function tracks($tracks) + { + return $this->setProperty('tracks', $tracks); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1390,6 +1562,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1433,190 +1619,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MusicComposition.php b/src/MusicComposition.php index f6194eaa4..2102b3e6d 100644 --- a/src/MusicComposition.php +++ b/src/MusicComposition.php @@ -13,148 +13,6 @@ */ class MusicComposition extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The person or organization who wrote a composition, or who is the - * composer of a work performed at some event. - * - * @param Organization|Organization[]|Person|Person[] $composer - * - * @return static - * - * @see http://schema.org/composer - */ - public function composer($composer) - { - return $this->setProperty('composer', $composer); - } - - /** - * The date and place the work was first performed. - * - * @param Event|Event[] $firstPerformance - * - * @return static - * - * @see http://schema.org/firstPerformance - */ - public function firstPerformance($firstPerformance) - { - return $this->setProperty('firstPerformance', $firstPerformance); - } - - /** - * Smaller compositions included in this work (e.g. a movement in a - * symphony). - * - * @param MusicComposition|MusicComposition[] $includedComposition - * - * @return static - * - * @see http://schema.org/includedComposition - */ - public function includedComposition($includedComposition) - { - return $this->setProperty('includedComposition', $includedComposition); - } - - /** - * The International Standard Musical Work Code for the composition. - * - * @param string|string[] $iswcCode - * - * @return static - * - * @see http://schema.org/iswcCode - */ - public function iswcCode($iswcCode) - { - return $this->setProperty('iswcCode', $iswcCode); - } - - /** - * The person who wrote the words. - * - * @param Person|Person[] $lyricist - * - * @return static - * - * @see http://schema.org/lyricist - */ - public function lyricist($lyricist) - { - return $this->setProperty('lyricist', $lyricist); - } - - /** - * The words in the song. - * - * @param CreativeWork|CreativeWork[] $lyrics - * - * @return static - * - * @see http://schema.org/lyrics - */ - public function lyrics($lyrics) - { - return $this->setProperty('lyrics', $lyrics); - } - - /** - * An arrangement derived from the composition. - * - * @param MusicComposition|MusicComposition[] $musicArrangement - * - * @return static - * - * @see http://schema.org/musicArrangement - */ - public function musicArrangement($musicArrangement) - { - return $this->setProperty('musicArrangement', $musicArrangement); - } - - /** - * The type of composition (e.g. overture, sonata, symphony, etc.). - * - * @param string|string[] $musicCompositionForm - * - * @return static - * - * @see http://schema.org/musicCompositionForm - */ - public function musicCompositionForm($musicCompositionForm) - { - return $this->setProperty('musicCompositionForm', $musicCompositionForm); - } - - /** - * The key, mode, or scale this composition uses. - * - * @param string|string[] $musicalKey - * - * @return static - * - * @see http://schema.org/musicalKey - */ - public function musicalKey($musicalKey) - { - return $this->setProperty('musicalKey', $musicalKey); - } - - /** - * An audio recording of the work. - * - * @param MusicRecording|MusicRecording[] $recordedAs - * - * @return static - * - * @see http://schema.org/recordedAs - */ - public function recordedAs($recordedAs) - { - return $this->setProperty('recordedAs', $recordedAs); - } - /** * The subject matter of the content. * @@ -299,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -314,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -474,6 +365,21 @@ public function commentCount($commentCount) return $this->setProperty('commentCount', $commentCount); } + /** + * The person or organization who wrote a composition, or who is the + * composer of a work performed at some event. + * + * @param Organization|Organization[]|Person|Person[] $composer + * + * @return static + * + * @see http://schema.org/composer + */ + public function composer($composer) + { + return $this->setProperty('composer', $composer); + } + /** * The location depicted or described in the content. For example, the * location in a photograph or painting. @@ -605,6 +511,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -772,6 +709,20 @@ public function fileFormat($fileFormat) return $this->setProperty('fileFormat', $fileFormat); } + /** + * The date and place the work was first performed. + * + * @param Event|Event[] $firstPerformance + * + * @return static + * + * @see http://schema.org/firstPerformance + */ + public function firstPerformance($firstPerformance) + { + return $this->setProperty('firstPerformance', $firstPerformance); + } + /** * A person or organization that supports (sponsors) something through some * kind of financial contribution. @@ -831,27 +782,75 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Language|Language[]|string|string[] $inLanguage + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/identifier */ - public function inLanguage($inLanguage) + public function identifier($identifier) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('identifier', $identifier); } /** - * The number of interactions for the CreativeWork using the WebSite or - * SoftwareApplication. The most specific child type of InteractionCounter - * should be used. - * + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * Smaller compositions included in this work (e.g. a movement in a + * symphony). + * + * @param MusicComposition|MusicComposition[] $includedComposition + * + * @return static + * + * @see http://schema.org/includedComposition + */ + public function includedComposition($includedComposition) + { + return $this->setProperty('includedComposition', $includedComposition); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * * @param InteractionCounter|InteractionCounter[] $interactionStatistic * * @return static @@ -952,6 +951,20 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Musical Work Code for the composition. + * + * @param string|string[] $iswcCode + * + * @return static + * + * @see http://schema.org/iswcCode + */ + public function iswcCode($iswcCode) + { + return $this->setProperty('iswcCode', $iswcCode); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1012,6 +1025,34 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * The person who wrote the words. + * + * @param Person|Person[] $lyricist + * + * @return static + * + * @see http://schema.org/lyricist + */ + public function lyricist($lyricist) + { + return $this->setProperty('lyricist', $lyricist); + } + + /** + * The words in the song. + * + * @param CreativeWork|CreativeWork[] $lyrics + * + * @return static + * + * @see http://schema.org/lyrics + */ + public function lyrics($lyrics) + { + return $this->setProperty('lyrics', $lyrics); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1027,6 +1068,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1057,6 +1114,62 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * An arrangement derived from the composition. + * + * @param MusicComposition|MusicComposition[] $musicArrangement + * + * @return static + * + * @see http://schema.org/musicArrangement + */ + public function musicArrangement($musicArrangement) + { + return $this->setProperty('musicArrangement', $musicArrangement); + } + + /** + * The type of composition (e.g. overture, sonata, symphony, etc.). + * + * @param string|string[] $musicCompositionForm + * + * @return static + * + * @see http://schema.org/musicCompositionForm + */ + public function musicCompositionForm($musicCompositionForm) + { + return $this->setProperty('musicCompositionForm', $musicCompositionForm); + } + + /** + * The key, mode, or scale this composition uses. + * + * @param string|string[] $musicalKey + * + * @return static + * + * @see http://schema.org/musicalKey + */ + public function musicalKey($musicalKey) + { + return $this->setProperty('musicalKey', $musicalKey); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1087,6 +1200,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1170,6 +1298,20 @@ public function publishingPrinciples($publishingPrinciples) return $this->setProperty('publishingPrinciples', $publishingPrinciples); } + /** + * An audio recording of the work. + * + * @param MusicRecording|MusicRecording[] $recordedAs + * + * @return static + * + * @see http://schema.org/recordedAs + */ + public function recordedAs($recordedAs) + { + return $this->setProperty('recordedAs', $recordedAs); + } + /** * The Event where the CreativeWork was recorded. The CreativeWork may * capture all or part of the event. @@ -1228,6 +1370,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1310,6 +1468,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1431,6 +1603,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1474,190 +1660,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MusicEvent.php b/src/MusicEvent.php index 740d48512..94ae25617 100644 --- a/src/MusicEvent.php +++ b/src/MusicEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MusicGroup.php b/src/MusicGroup.php index d37bc47ad..efa074d59 100644 --- a/src/MusicGroup.php +++ b/src/MusicGroup.php @@ -16,118 +16,93 @@ class MusicGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract { /** - * A music album. - * - * @param MusicAlbum|MusicAlbum[] $album - * - * @return static - * - * @see http://schema.org/album - */ - public function album($album) - { - return $this->setProperty('album', $album); - } - - /** - * A collection of music albums. - * - * @param MusicAlbum|MusicAlbum[] $albums - * - * @return static - * - * @see http://schema.org/albums - */ - public function albums($albums) - { - return $this->setProperty('albums', $albums); - } - - /** - * Genre of the creative work, broadcast channel or group. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $genre + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/genre + * @see http://schema.org/additionalType */ - public function genre($genre) + public function additionalType($additionalType) { - return $this->setProperty('genre', $genre); + return $this->setProperty('additionalType', $additionalType); } /** - * A member of a music group—for example, John, Paul, George, or - * Ringo. + * Physical address of the item. * - * @param Person|Person[] $musicGroupMember + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/musicGroupMember + * @see http://schema.org/address */ - public function musicGroupMember($musicGroupMember) + public function address($address) { - return $this->setProperty('musicGroupMember', $musicGroupMember); + return $this->setProperty('address', $address); } /** - * A music recording (track)—usually a single song. If an ItemList is - * given, the list should contain items of type MusicRecording. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/track + * @see http://schema.org/aggregateRating */ - public function track($track) + public function aggregateRating($aggregateRating) { - return $this->setProperty('track', $track); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * A music recording (track)—usually a single song. + * A music album. * - * @param MusicRecording|MusicRecording[] $tracks + * @param MusicAlbum|MusicAlbum[] $album * * @return static * - * @see http://schema.org/tracks + * @see http://schema.org/album */ - public function tracks($tracks) + public function album($album) { - return $this->setProperty('tracks', $tracks); + return $this->setProperty('album', $album); } /** - * Physical address of the item. + * A collection of music albums. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param MusicAlbum|MusicAlbum[] $albums * * @return static * - * @see http://schema.org/address + * @see http://schema.org/albums */ - public function address($address) + public function albums($albums) { - return $this->setProperty('address', $address); + return $this->setProperty('albums', $albums); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An alias for the item. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/alternateName */ - public function aggregateRating($aggregateRating) + public function alternateName($alternateName) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('alternateName', $alternateName); } /** @@ -232,6 +207,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -417,6 +423,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -463,6 +483,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -537,6 +590,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -595,6 +664,21 @@ public function members($members) return $this->setProperty('members', $members); } + /** + * A member of a music group—for example, John, Paul, George, or + * Ringo. + * + * @param Person|Person[] $musicGroupMember + * + * @return static + * + * @see http://schema.org/musicGroupMember + */ + public function musicGroupMember($musicGroupMember) + { + return $this->setProperty('musicGroupMember', $musicGroupMember); + } + /** * The North American Industry Classification System (NAICS) code for a * particular organization or business person. @@ -610,6 +694,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -667,6 +765,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -719,6 +832,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -794,6 +923,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -824,203 +967,60 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A music recording (track)—usually a single song. If an ItemList is + * given, the list should contain items of type MusicRecording. * - * @param Action|Action[] $potentialAction + * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/track */ - public function potentialAction($potentialAction) + public function track($track) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('track', $track); } /** - * 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. + * A music recording (track)—usually a single song. * - * @param string|string[] $sameAs + * @param MusicRecording|MusicRecording[] $tracks * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/tracks */ - public function sameAs($sameAs) + public function tracks($tracks) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('tracks', $tracks); } /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/MusicPlaylist.php b/src/MusicPlaylist.php index fcca0e358..131dd25e1 100644 --- a/src/MusicPlaylist.php +++ b/src/MusicPlaylist.php @@ -13,49 +13,6 @@ */ class MusicPlaylist extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The number of tracks in this album or playlist. - * - * @param int|int[] $numTracks - * - * @return static - * - * @see http://schema.org/numTracks - */ - public function numTracks($numTracks) - { - return $this->setProperty('numTracks', $numTracks); - } - - /** - * A music recording (track)—usually a single song. If an ItemList is - * given, the list should contain items of type MusicRecording. - * - * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track - * - * @return static - * - * @see http://schema.org/track - */ - public function track($track) - { - return $this->setProperty('track', $track); - } - - /** - * A music recording (track)—usually a single song. - * - * @param MusicRecording|MusicRecording[] $tracks - * - * @return static - * - * @see http://schema.org/tracks - */ - public function tracks($tracks) - { - return $this->setProperty('tracks', $tracks); - } - /** * The subject matter of the content. * @@ -200,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -215,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -506,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -731,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -928,6 +982,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -958,6 +1028,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of tracks in this album or playlist. + * + * @param int|int[] $numTracks + * + * @return static + * + * @see http://schema.org/numTracks + */ + public function numTracks($numTracks) + { + return $this->setProperty('numTracks', $numTracks); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -988,6 +1086,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1129,6 +1242,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1211,6 +1340,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1302,6 +1445,35 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * A music recording (track)—usually a single song. If an ItemList is + * given, the list should contain items of type MusicRecording. + * + * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track + * + * @return static + * + * @see http://schema.org/track + */ + public function track($track) + { + return $this->setProperty('track', $track); + } + + /** + * A music recording (track)—usually a single song. + * + * @param MusicRecording|MusicRecording[] $tracks + * + * @return static + * + * @see http://schema.org/tracks + */ + public function tracks($tracks) + { + return $this->setProperty('tracks', $tracks); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1332,6 +1504,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1375,190 +1561,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MusicRecording.php b/src/MusicRecording.php index 715bbedff..422316949 100644 --- a/src/MusicRecording.php +++ b/src/MusicRecording.php @@ -13,91 +13,6 @@ */ class MusicRecording extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The artist that performed this album or recording. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $byArtist - * - * @return static - * - * @see http://schema.org/byArtist - */ - public function byArtist($byArtist) - { - return $this->setProperty('byArtist', $byArtist); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * The album to which this recording belongs. - * - * @param MusicAlbum|MusicAlbum[] $inAlbum - * - * @return static - * - * @see http://schema.org/inAlbum - */ - public function inAlbum($inAlbum) - { - return $this->setProperty('inAlbum', $inAlbum); - } - - /** - * The playlist to which this recording belongs. - * - * @param MusicPlaylist|MusicPlaylist[] $inPlaylist - * - * @return static - * - * @see http://schema.org/inPlaylist - */ - public function inPlaylist($inPlaylist) - { - return $this->setProperty('inPlaylist', $inPlaylist); - } - - /** - * The International Standard Recording Code for the recording. - * - * @param string|string[] $isrcCode - * - * @return static - * - * @see http://schema.org/isrcCode - */ - public function isrcCode($isrcCode) - { - return $this->setProperty('isrcCode', $isrcCode); - } - - /** - * The composition this track is a recording of. - * - * @param MusicComposition|MusicComposition[] $recordingOf - * - * @return static - * - * @see http://schema.org/recordingOf - */ - public function recordingOf($recordingOf) - { - return $this->setProperty('recordingOf', $recordingOf); - } - /** * The subject matter of the content. * @@ -242,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -257,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -358,6 +306,20 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The artist that performed this album or recording. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $byArtist + * + * @return static + * + * @see http://schema.org/byArtist + */ + public function byArtist($byArtist) + { + return $this->setProperty('byArtist', $byArtist); + } + /** * Fictional person connected with a creative work. * @@ -548,6 +510,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -562,6 +555,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -773,6 +781,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * The album to which this recording belongs. + * + * @param MusicAlbum|MusicAlbum[] $inAlbum + * + * @return static + * + * @see http://schema.org/inAlbum + */ + public function inAlbum($inAlbum) + { + return $this->setProperty('inAlbum', $inAlbum); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -790,6 +845,20 @@ public function inLanguage($inLanguage) return $this->setProperty('inLanguage', $inLanguage); } + /** + * The playlist to which this recording belongs. + * + * @param MusicPlaylist|MusicPlaylist[] $inPlaylist + * + * @return static + * + * @see http://schema.org/inPlaylist + */ + public function inPlaylist($inPlaylist) + { + return $this->setProperty('inPlaylist', $inPlaylist); + } + /** * The number of interactions for the CreativeWork using the WebSite or * SoftwareApplication. The most specific child type of InteractionCounter @@ -895,6 +964,20 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Recording Code for the recording. + * + * @param string|string[] $isrcCode + * + * @return static + * + * @see http://schema.org/isrcCode + */ + public function isrcCode($isrcCode) + { + return $this->setProperty('isrcCode', $isrcCode); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -971,9 +1054,25 @@ public function mainEntity($mainEntity) } /** - * A material that something is made from, e.g. leather, wool, cotton, - * paper. - * + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * * @param Product|Product[]|string|string[] $material * * @return static @@ -1000,6 +1099,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1030,6 +1143,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1128,6 +1256,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The composition this track is a recording of. + * + * @param MusicComposition|MusicComposition[] $recordingOf + * + * @return static + * + * @see http://schema.org/recordingOf + */ + public function recordingOf($recordingOf) + { + return $this->setProperty('recordingOf', $recordingOf); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1171,6 +1313,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1253,6 +1411,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1374,6 +1546,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1417,190 +1603,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MusicRelease.php b/src/MusicRelease.php index 5e00d0ea6..bf3cbaa9c 100644 --- a/src/MusicRelease.php +++ b/src/MusicRelease.php @@ -14,122 +14,6 @@ */ class MusicRelease extends BaseType implements MusicPlaylistContract, CreativeWorkContract, ThingContract { - /** - * The catalog number for the release. - * - * @param string|string[] $catalogNumber - * - * @return static - * - * @see http://schema.org/catalogNumber - */ - public function catalogNumber($catalogNumber) - { - return $this->setProperty('catalogNumber', $catalogNumber); - } - - /** - * The group the release is credited to if different than the byArtist. For - * example, Red and Blue is credited to "Stefani Germanotta Band", but by - * Lady Gaga. - * - * @param Organization|Organization[]|Person|Person[] $creditedTo - * - * @return static - * - * @see http://schema.org/creditedTo - */ - public function creditedTo($creditedTo) - { - return $this->setProperty('creditedTo', $creditedTo); - } - - /** - * Format of this release (the type of recording media used, ie. compact - * disc, digital media, LP, etc.). - * - * @param MusicReleaseFormatType|MusicReleaseFormatType[] $musicReleaseFormat - * - * @return static - * - * @see http://schema.org/musicReleaseFormat - */ - public function musicReleaseFormat($musicReleaseFormat) - { - return $this->setProperty('musicReleaseFormat', $musicReleaseFormat); - } - - /** - * The label that issued the release. - * - * @param Organization|Organization[] $recordLabel - * - * @return static - * - * @see http://schema.org/recordLabel - */ - public function recordLabel($recordLabel) - { - return $this->setProperty('recordLabel', $recordLabel); - } - - /** - * The album this is a release of. - * - * @param MusicAlbum|MusicAlbum[] $releaseOf - * - * @return static - * - * @see http://schema.org/releaseOf - */ - public function releaseOf($releaseOf) - { - return $this->setProperty('releaseOf', $releaseOf); - } - - /** - * The number of tracks in this album or playlist. - * - * @param int|int[] $numTracks - * - * @return static - * - * @see http://schema.org/numTracks - */ - public function numTracks($numTracks) - { - return $this->setProperty('numTracks', $numTracks); - } - - /** - * A music recording (track)—usually a single song. If an ItemList is - * given, the list should contain items of type MusicRecording. - * - * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track - * - * @return static - * - * @see http://schema.org/track - */ - public function track($track) - { - return $this->setProperty('track', $track); - } - - /** - * A music recording (track)—usually a single song. - * - * @param MusicRecording|MusicRecording[] $tracks - * - * @return static - * - * @see http://schema.org/tracks - */ - public function tracks($tracks) - { - return $this->setProperty('tracks', $tracks); - } - /** * The subject matter of the content. * @@ -274,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -289,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -390,6 +307,20 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The catalog number for the release. + * + * @param string|string[] $catalogNumber + * + * @return static + * + * @see http://schema.org/catalogNumber + */ + public function catalogNumber($catalogNumber) + { + return $this->setProperty('catalogNumber', $catalogNumber); + } + /** * Fictional person connected with a creative work. * @@ -536,6 +467,22 @@ public function creator($creator) return $this->setProperty('creator', $creator); } + /** + * The group the release is credited to if different than the byArtist. For + * example, Red and Blue is credited to "Stefani Germanotta Band", but by + * Lady Gaga. + * + * @param Organization|Organization[]|Person|Person[] $creditedTo + * + * @return static + * + * @see http://schema.org/creditedTo + */ + public function creditedTo($creditedTo) + { + return $this->setProperty('creditedTo', $creditedTo); + } + /** * The date on which the CreativeWork was created or the item was added to a * DataFeed. @@ -580,6 +527,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -805,6 +783,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1003,18 +1014,34 @@ public function mainEntity($mainEntity) } /** - * A material that something is made from, e.g. leather, wool, cotton, - * paper. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Product|Product[]|string|string[] $material + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/material + * @see http://schema.org/mainEntityOfPage */ - public function material($material) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('material', $material); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); } /** @@ -1032,6 +1059,49 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * Format of this release (the type of recording media used, ie. compact + * disc, digital media, LP, etc.). + * + * @param MusicReleaseFormatType|MusicReleaseFormatType[] $musicReleaseFormat + * + * @return static + * + * @see http://schema.org/musicReleaseFormat + */ + public function musicReleaseFormat($musicReleaseFormat) + { + return $this->setProperty('musicReleaseFormat', $musicReleaseFormat); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of tracks in this album or playlist. + * + * @param int|int[] $numTracks + * + * @return static + * + * @see http://schema.org/numTracks + */ + public function numTracks($numTracks) + { + return $this->setProperty('numTracks', $numTracks); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1062,6 +1132,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1145,6 +1230,20 @@ public function publishingPrinciples($publishingPrinciples) return $this->setProperty('publishingPrinciples', $publishingPrinciples); } + /** + * The label that issued the release. + * + * @param Organization|Organization[] $recordLabel + * + * @return static + * + * @see http://schema.org/recordLabel + */ + public function recordLabel($recordLabel) + { + return $this->setProperty('recordLabel', $recordLabel); + } + /** * The Event where the CreativeWork was recorded. The CreativeWork may * capture all or part of the event. @@ -1160,6 +1259,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The album this is a release of. + * + * @param MusicAlbum|MusicAlbum[] $releaseOf + * + * @return static + * + * @see http://schema.org/releaseOf + */ + public function releaseOf($releaseOf) + { + return $this->setProperty('releaseOf', $releaseOf); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1203,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1285,6 +1414,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1376,6 +1519,35 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * A music recording (track)—usually a single song. If an ItemList is + * given, the list should contain items of type MusicRecording. + * + * @param ItemList|ItemList[]|MusicRecording|MusicRecording[] $track + * + * @return static + * + * @see http://schema.org/track + */ + public function track($track) + { + return $this->setProperty('track', $track); + } + + /** + * A music recording (track)—usually a single song. + * + * @param MusicRecording|MusicRecording[] $tracks + * + * @return static + * + * @see http://schema.org/tracks + */ + public function tracks($tracks) + { + return $this->setProperty('tracks', $tracks); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1406,6 +1578,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1449,190 +1635,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/MusicStore.php b/src/MusicStore.php index 930a0492e..cbb9bde78 100644 --- a/src/MusicStore.php +++ b/src/MusicStore.php @@ -17,126 +17,104 @@ class MusicStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/MusicVenue.php b/src/MusicVenue.php index 25ee1e864..b58021eb7 100644 --- a/src/MusicVenue.php +++ b/src/MusicVenue.php @@ -14,35 +14,6 @@ */ class MusicVenue extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/MusicVideoObject.php b/src/MusicVideoObject.php index f536e609a..048015878 100644 --- a/src/MusicVideoObject.php +++ b/src/MusicVideoObject.php @@ -14,284 +14,6 @@ */ class MusicVideoObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { - /** - * A NewsArticle associated with the Media Object. - * - * @param NewsArticle|NewsArticle[] $associatedArticle - * - * @return static - * - * @see http://schema.org/associatedArticle - */ - public function associatedArticle($associatedArticle) - { - return $this->setProperty('associatedArticle', $associatedArticle); - } - - /** - * The bitrate of the media object. - * - * @param string|string[] $bitrate - * - * @return static - * - * @see http://schema.org/bitrate - */ - public function bitrate($bitrate) - { - return $this->setProperty('bitrate', $bitrate); - } - - /** - * File size in (mega/kilo) bytes. - * - * @param string|string[] $contentSize - * - * @return static - * - * @see http://schema.org/contentSize - */ - public function contentSize($contentSize) - { - return $this->setProperty('contentSize', $contentSize); - } - - /** - * Actual bytes of the media object, for example the image file or video - * file. - * - * @param string|string[] $contentUrl - * - * @return static - * - * @see http://schema.org/contentUrl - */ - public function contentUrl($contentUrl) - { - return $this->setProperty('contentUrl', $contentUrl); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * A URL pointing to a player for a specific video. In general, this is the - * information in the ```src``` element of an ```embed``` tag and should not - * be the same as the content of the ```loc``` tag. - * - * @param string|string[] $embedUrl - * - * @return static - * - * @see http://schema.org/embedUrl - */ - public function embedUrl($embedUrl) - { - return $this->setProperty('embedUrl', $embedUrl); - } - - /** - * The CreativeWork encoded by this media object. - * - * @param CreativeWork|CreativeWork[] $encodesCreativeWork - * - * @return static - * - * @see http://schema.org/encodesCreativeWork - */ - public function encodesCreativeWork($encodesCreativeWork) - { - return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); - } - - /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside - * particular [[encodingFormat]] information. - * - * Unregistered or niche encoding and file formats can be indicated instead - * via the most appropriate URL, e.g. defining Web page or a - * Wikipedia/Wikidata entry. - * - * @param string|string[] $encodingFormat - * - * @return static - * - * @see http://schema.org/encodingFormat - */ - public function encodingFormat($encodingFormat) - { - return $this->setProperty('encodingFormat', $encodingFormat); - } - - /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime - * - * @return static - * - * @see http://schema.org/endTime - */ - public function endTime($endTime) - { - return $this->setProperty('endTime', $endTime); - } - - /** - * The height of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height - * - * @return static - * - * @see http://schema.org/height - */ - public function height($height) - { - return $this->setProperty('height', $height); - } - - /** - * Player type required—for example, Flash or Silverlight. - * - * @param string|string[] $playerType - * - * @return static - * - * @see http://schema.org/playerType - */ - public function playerType($playerType) - { - return $this->setProperty('playerType', $playerType); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The regions where the media is allowed. If not specified, then it's - * assumed to be allowed everywhere. Specify the countries in [ISO 3166 - * format](http://en.wikipedia.org/wiki/ISO_3166). - * - * @param Place|Place[] $regionsAllowed - * - * @return static - * - * @see http://schema.org/regionsAllowed - */ - public function regionsAllowed($regionsAllowed) - { - return $this->setProperty('regionsAllowed', $regionsAllowed); - } - - /** - * Indicates if use of the media require a subscription (either paid or - * free). Allowed values are ```true``` or ```false``` (note that an earlier - * version had 'yes', 'no'). - * - * @param bool|bool[] $requiresSubscription - * - * @return static - * - * @see http://schema.org/requiresSubscription - */ - public function requiresSubscription($requiresSubscription) - { - return $this->setProperty('requiresSubscription', $requiresSubscription); - } - - /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime - * - * @return static - * - * @see http://schema.org/startTime - */ - public function startTime($startTime) - { - return $this->setProperty('startTime', $startTime); - } - - /** - * Date when this media object was uploaded to this site. - * - * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate - * - * @return static - * - * @see http://schema.org/uploadDate - */ - public function uploadDate($uploadDate) - { - return $this->setProperty('uploadDate', $uploadDate); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - /** * The subject matter of the content. * @@ -436,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -451,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -465,6 +220,20 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -552,6 +321,20 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + /** * Fictional person connected with a creative work. * @@ -640,6 +423,35 @@ public function contentRating($contentRating) return $this->setProperty('contentRating', $contentRating); } + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + /** * A secondary contributor to the CreativeWork or Event. * @@ -742,18 +554,64 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * - * @param string|string[] $discussionUrl + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/duration */ - public function discussionUrl($discussionUrl) + public function duration($duration) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('duration', $duration); } /** @@ -799,6 +657,36 @@ public function educationalUse($educationalUse) return $this->setProperty('educationalUse', $educationalUse); } + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for associatedMedia. @@ -814,6 +702,33 @@ public function encoding($encoding) return $this->setProperty('encoding', $encoding); } + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat + * + * @return static + * + * @see http://schema.org/encodingFormat + */ + public function encodingFormat($encodingFormat) + { + return $this->setProperty('encodingFormat', $encodingFormat); + } + /** * A media object that encodes this CreativeWork. * @@ -828,6 +743,29 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * + * @return static + * + * @see http://schema.org/endTime + */ + public function endTime($endTime) + { + return $this->setProperty('endTime', $endTime); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -940,6 +878,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1137,6 +1122,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1167,6 +1168,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1183,6 +1198,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + /** * The position of an item in a series or sequence of items. * @@ -1197,6 +1226,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1212,6 +1256,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1295,6 +1354,22 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1310,6 +1385,22 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + /** * A review of the item. * @@ -1325,17 +1416,33 @@ public function review($review) } /** - * Review of the item. + * Review of the item. + * + * @param Review|Review[] $reviews + * + * @return static + * + * @see http://schema.org/reviews + */ + public function reviews($reviews) + { + return $this->setProperty('reviews', $reviews); + } + + /** + * 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. * - * @param Review|Review[] $reviews + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/sameAs */ - public function reviews($reviews) + public function sameAs($sameAs) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('sameAs', $sameAs); } /** @@ -1420,6 +1527,43 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1542,232 +1686,88 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Date when this media object was uploaded to this site. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/uploadDate */ - public function mainEntityOfPage($mainEntityOfPage) + public function uploadDate($uploadDate) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('uploadDate', $uploadDate); } /** - * The name of the item. + * URL of the item. * - * @param string|string[] $name + * @param string|string[] $url * * @return static * - * @see http://schema.org/name + * @see http://schema.org/url */ - public function name($name) + public function url($url) { - return $this->setProperty('name', $name); + return $this->setProperty('url', $url); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The version of the CreativeWork embodied by a specified resource. * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/version */ - public function potentialAction($potentialAction) + public function version($version) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('version', $version); } /** - * 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. + * An embedded video object. * - * @param string|string[] $sameAs + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/video */ - public function sameAs($sameAs) + public function video($video) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('video', $video); } /** - * A CreativeWork or Event about this Thing. + * The width of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/width */ - public function subjectOf($subjectOf) + public function width($width) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('width', $width); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/NGO.php b/src/NGO.php index 3cf7b5374..93c09fe14 100644 --- a/src/NGO.php +++ b/src/NGO.php @@ -13,6 +13,25 @@ */ class NGO extends BaseType implements OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -42,6 +61,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -144,6 +177,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -375,6 +439,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -449,6 +546,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -522,6 +635,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -579,6 +706,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -631,6 +773,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -706,6 +864,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -736,203 +908,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/NailSalon.php b/src/NailSalon.php index d59c6c477..00cc7aa28 100644 --- a/src/NailSalon.php +++ b/src/NailSalon.php @@ -17,126 +17,104 @@ class NailSalon extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/NewsArticle.php b/src/NewsArticle.php index 0d0c987c2..84157d86b 100644 --- a/src/NewsArticle.php +++ b/src/NewsArticle.php @@ -18,218 +18,6 @@ */ class NewsArticle extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { - /** - * A [dateline](https://en.wikipedia.org/wiki/Dateline) is a brief piece of - * text included in news articles that describes where and when the story - * was written or filed though the date is often omitted. Sometimes only a - * placename is provided. - * - * Structured representations of dateline-related information can also be - * expressed more explicitly using [[locationCreated]] (which represents - * where a work was created e.g. where a news report was written). For - * location depicted or described in the content, use [[contentLocation]]. - * - * Dateline summaries are oriented more towards human readers than towards - * automated processing, and can vary substantially. Some examples: "BEIRUT, - * Lebanon, June 2.", "Paris, France", "December 19, 2017 11:43AM Reporting - * from Washington", "Beijing/Moscow", "QUEZON CITY, Philippines". - * - * @param string|string[] $dateline - * - * @return static - * - * @see http://schema.org/dateline - */ - public function dateline($dateline) - { - return $this->setProperty('dateline', $dateline); - } - - /** - * The number of the column in which the NewsArticle appears in the print - * edition. - * - * @param string|string[] $printColumn - * - * @return static - * - * @see http://schema.org/printColumn - */ - public function printColumn($printColumn) - { - return $this->setProperty('printColumn', $printColumn); - } - - /** - * The edition of the print product in which the NewsArticle appears. - * - * @param string|string[] $printEdition - * - * @return static - * - * @see http://schema.org/printEdition - */ - public function printEdition($printEdition) - { - return $this->setProperty('printEdition', $printEdition); - } - - /** - * If this NewsArticle appears in print, this field indicates the name of - * the page on which the article is found. Please note that this field is - * intended for the exact page name (e.g. A5, B18). - * - * @param string|string[] $printPage - * - * @return static - * - * @see http://schema.org/printPage - */ - public function printPage($printPage) - { - return $this->setProperty('printPage', $printPage); - } - - /** - * If this NewsArticle appears in print, this field indicates the print - * section in which the article appeared. - * - * @param string|string[] $printSection - * - * @return static - * - * @see http://schema.org/printSection - */ - public function printSection($printSection) - { - return $this->setProperty('printSection', $printSection); - } - - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -374,6 +162,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -389,6 +196,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -403,6 +224,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -669,15 +519,73 @@ public function dateModified($dateModified) /** * Date of first broadcast/publication. * - * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished + * + * @return static + * + * @see http://schema.org/datePublished + */ + public function datePublished($datePublished) + { + return $this->setProperty('datePublished', $datePublished); + } + + /** + * A [dateline](https://en.wikipedia.org/wiki/Dateline) is a brief piece of + * text included in news articles that describes where and when the story + * was written or filed though the date is often omitted. Sometimes only a + * placename is provided. + * + * Structured representations of dateline-related information can also be + * expressed more explicitly using [[locationCreated]] (which represents + * where a work was created e.g. where a news report was written). For + * location depicted or described in the content, use [[contentLocation]]. + * + * Dateline summaries are oriented more towards human readers than towards + * automated processing, and can vary substantially. Some examples: "BEIRUT, + * Lebanon, June 2.", "Paris, France", "December 19, 2017 11:43AM Reporting + * from Washington", "Beijing/Moscow", "QUEZON CITY, Philippines". + * + * @param string|string[] $dateline + * + * @return static + * + * @see http://schema.org/dateline + */ + public function dateline($dateline) + { + return $this->setProperty('dateline', $dateline); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/datePublished + * @see http://schema.org/disambiguatingDescription */ - public function datePublished($datePublished) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('datePublished', $datePublished); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -905,6 +813,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1102,6 +1043,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1132,6 +1089,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1148,6 +1119,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1162,6 +1176,81 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * The number of the column in which the NewsArticle appears in the print + * edition. + * + * @param string|string[] $printColumn + * + * @return static + * + * @see http://schema.org/printColumn + */ + public function printColumn($printColumn) + { + return $this->setProperty('printColumn', $printColumn); + } + + /** + * The edition of the print product in which the NewsArticle appears. + * + * @param string|string[] $printEdition + * + * @return static + * + * @see http://schema.org/printEdition + */ + public function printEdition($printEdition) + { + return $this->setProperty('printEdition', $printEdition); + } + + /** + * If this NewsArticle appears in print, this field indicates the name of + * the page on which the article is found. Please note that this field is + * intended for the exact page name (e.g. A5, B18). + * + * @param string|string[] $printPage + * + * @return static + * + * @see http://schema.org/printPage + */ + public function printPage($printPage) + { + return $this->setProperty('printPage', $printPage); + } + + /** + * If this NewsArticle appears in print, this field indicates the print + * section in which the article appeared. + * + * @param string|string[] $printSection + * + * @return static + * + * @see http://schema.org/printSection + */ + public function printSection($printSection) + { + return $this->setProperty('printSection', $printSection); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1303,6 +1392,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1339,50 +1444,103 @@ public function sourceOrganization($sourceOrganization) * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are * not known to be appropriate. * - * @param Place|Place[] $spatial + * @param Place|Place[] $spatial + * + * @return static + * + * @see http://schema.org/spatial + */ + public function spatial($spatial) + { + return $this->setProperty('spatial', $spatial); + } + + /** + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. + * + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable * * @return static * - * @see http://schema.org/spatial + * @see http://schema.org/speakable */ - public function spatial($spatial) + public function speakable($speakable) { - return $this->setProperty('spatial', $spatial); + return $this->setProperty('speakable', $speakable); } /** - * The spatialCoverage of a CreativeWork indicates the place(s) which are - * the focus of the content. It is a subproperty of - * contentLocation intended primarily for more technical and detailed - * materials. For example with a Dataset, it indicates - * areas that the dataset describes: a dataset of New York weather - * would have spatialCoverage which was the place: the state of New York. + * 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. * - * @param Place|Place[] $spatialCoverage + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/sponsor */ - public function spatialCoverage($spatialCoverage) + public function sponsor($sponsor) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('sponsor', $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. + * A CreativeWork or Event about this Thing. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/subjectOf */ - public function sponsor($sponsor) + public function subjectOf($subjectOf) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('subjectOf', $subjectOf); } /** @@ -1506,6 +1664,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1535,204 +1707,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/NightClub.php b/src/NightClub.php index 93689eb19..12317ac86 100644 --- a/src/NightClub.php +++ b/src/NightClub.php @@ -17,126 +17,104 @@ class NightClub extends BaseType implements EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Notary.php b/src/Notary.php index abd439477..150fe1a95 100644 --- a/src/Notary.php +++ b/src/Notary.php @@ -17,126 +17,104 @@ class Notary extends BaseType implements LegalServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/NoteDigitalDocument.php b/src/NoteDigitalDocument.php index 79eb51237..5730ee066 100644 --- a/src/NoteDigitalDocument.php +++ b/src/NoteDigitalDocument.php @@ -14,22 +14,6 @@ */ class NoteDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract { - /** - * A permission related to the access to this document (e.g. permission to - * read or write an electronic document). For a public document, specify a - * grantee with an Audience with audienceType equal to "public". - * - * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission - * - * @return static - * - * @see http://schema.org/hasDigitalDocumentPermission - */ - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) - { - return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); - } - /** * The subject matter of the content. * @@ -174,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -189,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -480,6 +497,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -676,6 +724,22 @@ public function genre($genre) return $this->setProperty('genre', $genre); } + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + /** * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). @@ -705,6 +769,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -902,6 +999,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -932,6 +1045,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -962,6 +1089,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1103,6 +1245,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1185,6 +1343,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1306,6 +1478,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1349,190 +1535,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/NutritionInformation.php b/src/NutritionInformation.php index d68d5ea07..dc5970520 100644 --- a/src/NutritionInformation.php +++ b/src/NutritionInformation.php @@ -15,343 +15,343 @@ class NutritionInformation extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** - * The number of calories. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Energy|Energy[] $calories + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/calories + * @see http://schema.org/additionalType */ - public function calories($calories) + public function additionalType($additionalType) { - return $this->setProperty('calories', $calories); + return $this->setProperty('additionalType', $additionalType); } /** - * The number of grams of carbohydrates. + * An alias for the item. * - * @param Mass|Mass[] $carbohydrateContent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/carbohydrateContent + * @see http://schema.org/alternateName */ - public function carbohydrateContent($carbohydrateContent) + public function alternateName($alternateName) { - return $this->setProperty('carbohydrateContent', $carbohydrateContent); + return $this->setProperty('alternateName', $alternateName); } /** - * The number of milligrams of cholesterol. + * The number of calories. * - * @param Mass|Mass[] $cholesterolContent + * @param Energy|Energy[] $calories * * @return static * - * @see http://schema.org/cholesterolContent + * @see http://schema.org/calories */ - public function cholesterolContent($cholesterolContent) + public function calories($calories) { - return $this->setProperty('cholesterolContent', $cholesterolContent); + return $this->setProperty('calories', $calories); } /** - * The number of grams of fat. + * The number of grams of carbohydrates. * - * @param Mass|Mass[] $fatContent + * @param Mass|Mass[] $carbohydrateContent * * @return static * - * @see http://schema.org/fatContent + * @see http://schema.org/carbohydrateContent */ - public function fatContent($fatContent) + public function carbohydrateContent($carbohydrateContent) { - return $this->setProperty('fatContent', $fatContent); + return $this->setProperty('carbohydrateContent', $carbohydrateContent); } /** - * The number of grams of fiber. + * The number of milligrams of cholesterol. * - * @param Mass|Mass[] $fiberContent + * @param Mass|Mass[] $cholesterolContent * * @return static * - * @see http://schema.org/fiberContent + * @see http://schema.org/cholesterolContent */ - public function fiberContent($fiberContent) + public function cholesterolContent($cholesterolContent) { - return $this->setProperty('fiberContent', $fiberContent); + return $this->setProperty('cholesterolContent', $cholesterolContent); } /** - * The number of grams of protein. + * A description of the item. * - * @param Mass|Mass[] $proteinContent + * @param string|string[] $description * * @return static * - * @see http://schema.org/proteinContent + * @see http://schema.org/description */ - public function proteinContent($proteinContent) + public function description($description) { - return $this->setProperty('proteinContent', $proteinContent); + return $this->setProperty('description', $description); } /** - * The number of grams of saturated fat. + * 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. * - * @param Mass|Mass[] $saturatedFatContent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/saturatedFatContent + * @see http://schema.org/disambiguatingDescription */ - public function saturatedFatContent($saturatedFatContent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('saturatedFatContent', $saturatedFatContent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The serving size, in terms of the number of volume or mass. + * The number of grams of fat. * - * @param string|string[] $servingSize + * @param Mass|Mass[] $fatContent * * @return static * - * @see http://schema.org/servingSize + * @see http://schema.org/fatContent */ - public function servingSize($servingSize) + public function fatContent($fatContent) { - return $this->setProperty('servingSize', $servingSize); + return $this->setProperty('fatContent', $fatContent); } /** - * The number of milligrams of sodium. + * The number of grams of fiber. * - * @param Mass|Mass[] $sodiumContent + * @param Mass|Mass[] $fiberContent * * @return static * - * @see http://schema.org/sodiumContent + * @see http://schema.org/fiberContent */ - public function sodiumContent($sodiumContent) + public function fiberContent($fiberContent) { - return $this->setProperty('sodiumContent', $sodiumContent); + return $this->setProperty('fiberContent', $fiberContent); } /** - * The number of grams of sugar. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Mass|Mass[] $sugarContent + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/sugarContent + * @see http://schema.org/identifier */ - public function sugarContent($sugarContent) + public function identifier($identifier) { - return $this->setProperty('sugarContent', $sugarContent); + return $this->setProperty('identifier', $identifier); } /** - * The number of grams of trans fat. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Mass|Mass[] $transFatContent + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/transFatContent + * @see http://schema.org/image */ - public function transFatContent($transFatContent) + public function image($image) { - return $this->setProperty('transFatContent', $transFatContent); + return $this->setProperty('image', $image); } /** - * The number of grams of unsaturated fat. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Mass|Mass[] $unsaturatedFatContent + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/unsaturatedFatContent + * @see http://schema.org/mainEntityOfPage */ - public function unsaturatedFatContent($unsaturatedFatContent) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('unsaturatedFatContent', $unsaturatedFatContent); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The number of grams of protein. * - * @param string|string[] $description + * @param Mass|Mass[] $proteinContent * * @return static * - * @see http://schema.org/description + * @see http://schema.org/proteinContent */ - public function description($description) + public function proteinContent($proteinContent) { - return $this->setProperty('description', $description); + return $this->setProperty('proteinContent', $proteinContent); } /** - * 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. + * 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. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/sameAs */ - public function disambiguatingDescription($disambiguatingDescription) + public function sameAs($sameAs) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('sameAs', $sameAs); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The number of grams of saturated fat. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Mass|Mass[] $saturatedFatContent * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/saturatedFatContent */ - public function identifier($identifier) + public function saturatedFatContent($saturatedFatContent) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('saturatedFatContent', $saturatedFatContent); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The serving size, in terms of the number of volume or mass. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $servingSize * * @return static * - * @see http://schema.org/image + * @see http://schema.org/servingSize */ - public function image($image) + public function servingSize($servingSize) { - return $this->setProperty('image', $image); + return $this->setProperty('servingSize', $servingSize); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The number of milligrams of sodium. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Mass|Mass[] $sodiumContent * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sodiumContent */ - public function mainEntityOfPage($mainEntityOfPage) + public function sodiumContent($sodiumContent) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sodiumContent', $sodiumContent); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The number of grams of sugar. * - * @param Action|Action[] $potentialAction + * @param Mass|Mass[] $sugarContent * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/sugarContent */ - public function potentialAction($potentialAction) + public function sugarContent($sugarContent) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('sugarContent', $sugarContent); } /** - * 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. + * The number of grams of trans fat. * - * @param string|string[] $sameAs + * @param Mass|Mass[] $transFatContent * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/transFatContent */ - public function sameAs($sameAs) + public function transFatContent($transFatContent) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('transFatContent', $transFatContent); } /** - * A CreativeWork or Event about this Thing. + * The number of grams of unsaturated fat. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Mass|Mass[] $unsaturatedFatContent * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/unsaturatedFatContent */ - public function subjectOf($subjectOf) + public function unsaturatedFatContent($unsaturatedFatContent) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('unsaturatedFatContent', $unsaturatedFatContent); } /** diff --git a/src/Occupation.php b/src/Occupation.php index 7634a1503..d52483923 100644 --- a/src/Occupation.php +++ b/src/Occupation.php @@ -14,288 +14,288 @@ class Occupation extends BaseType implements IntangibleContract, ThingContract { /** - * Educational background needed for the position or Occupation. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $educationRequirements + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/educationRequirements + * @see http://schema.org/additionalType */ - public function educationRequirements($educationRequirements) + public function additionalType($additionalType) { - return $this->setProperty('educationRequirements', $educationRequirements); + return $this->setProperty('additionalType', $additionalType); } /** - * An estimated salary for a job posting or occupation, based on a variety - * of variables including, but not limited to industry, job title, and - * location. Estimated salaries are often computed by outside organizations - * rather than the hiring organization, who may not have committed to the - * estimated value. + * An alias for the item. * - * @param MonetaryAmount|MonetaryAmountDistribution|MonetaryAmountDistribution[]|MonetaryAmount[]|float|float[]|int|int[] $estimatedSalary + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/estimatedSalary + * @see http://schema.org/alternateName */ - public function estimatedSalary($estimatedSalary) + public function alternateName($alternateName) { - return $this->setProperty('estimatedSalary', $estimatedSalary); + return $this->setProperty('alternateName', $alternateName); } /** - * Description of skills and experience needed for the position or - * Occupation. + * A description of the item. * - * @param string|string[] $experienceRequirements + * @param string|string[] $description * * @return static * - * @see http://schema.org/experienceRequirements + * @see http://schema.org/description */ - public function experienceRequirements($experienceRequirements) + public function description($description) { - return $this->setProperty('experienceRequirements', $experienceRequirements); + return $this->setProperty('description', $description); } /** - * The region/country for which this occupational description is - * appropriate. Note that educational requirements and qualifications can - * vary between jurisdictions. + * 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. * - * @param AdministrativeArea|AdministrativeArea[] $occupationLocation + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/occupationLocation + * @see http://schema.org/disambiguatingDescription */ - public function occupationLocation($occupationLocation) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('occupationLocation', $occupationLocation); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A category describing the job, preferably using a term from a taxonomy - * such as [BLS O*NET-SOC](http://www.onetcenter.org/taxonomy.html), - * [ISCO-08](https://www.ilo.org/public/english/bureau/stat/isco/isco08/) or - * similar, with the property repeated for each applicable value. Ideally - * the taxonomy should be identified, and both the textual label and formal - * code for the category should be provided. - * - * Note: for historical reasons, any textual label and formal code provided - * as a literal may be assumed to be from O*NET-SOC. + * Educational background needed for the position or Occupation. * - * @param string|string[] $occupationalCategory + * @param string|string[] $educationRequirements * * @return static * - * @see http://schema.org/occupationalCategory + * @see http://schema.org/educationRequirements */ - public function occupationalCategory($occupationalCategory) + public function educationRequirements($educationRequirements) { - return $this->setProperty('occupationalCategory', $occupationalCategory); + return $this->setProperty('educationRequirements', $educationRequirements); } /** - * Specific qualifications required for this role or Occupation. + * An estimated salary for a job posting or occupation, based on a variety + * of variables including, but not limited to industry, job title, and + * location. Estimated salaries are often computed by outside organizations + * rather than the hiring organization, who may not have committed to the + * estimated value. * - * @param string|string[] $qualifications + * @param MonetaryAmount|MonetaryAmountDistribution|MonetaryAmountDistribution[]|MonetaryAmount[]|float|float[]|int|int[] $estimatedSalary * * @return static * - * @see http://schema.org/qualifications + * @see http://schema.org/estimatedSalary */ - public function qualifications($qualifications) + public function estimatedSalary($estimatedSalary) { - return $this->setProperty('qualifications', $qualifications); + return $this->setProperty('estimatedSalary', $estimatedSalary); } /** - * Responsibilities associated with this role or Occupation. + * Description of skills and experience needed for the position or + * Occupation. * - * @param string|string[] $responsibilities + * @param string|string[] $experienceRequirements * * @return static * - * @see http://schema.org/responsibilities + * @see http://schema.org/experienceRequirements */ - public function responsibilities($responsibilities) + public function experienceRequirements($experienceRequirements) { - return $this->setProperty('responsibilities', $responsibilities); + return $this->setProperty('experienceRequirements', $experienceRequirements); } /** - * Skills required to fulfill this role or in this Occupation. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $skills + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/skills + * @see http://schema.org/identifier */ - public function skills($skills) + public function identifier($identifier) { - return $this->setProperty('skills', $skills); + return $this->setProperty('identifier', $identifier); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/image */ - public function additionalType($additionalType) + public function image($image) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('image', $image); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The region/country for which this occupational description is + * appropriate. Note that educational requirements and qualifications can + * vary between jurisdictions. * - * @param string|string[] $disambiguatingDescription + * @param AdministrativeArea|AdministrativeArea[] $occupationLocation * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/occupationLocation */ - public function disambiguatingDescription($disambiguatingDescription) + public function occupationLocation($occupationLocation) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('occupationLocation', $occupationLocation); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A category describing the job, preferably using a term from a taxonomy + * such as [BLS O*NET-SOC](http://www.onetcenter.org/taxonomy.html), + * [ISCO-08](https://www.ilo.org/public/english/bureau/stat/isco/isco08/) or + * similar, with the property repeated for each applicable value. Ideally + * the taxonomy should be identified, and both the textual label and formal + * code for the category should be provided. + * + * Note: for historical reasons, any textual label and formal code provided + * as a literal may be assumed to be from O*NET-SOC. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $occupationalCategory * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/occupationalCategory */ - public function identifier($identifier) + public function occupationalCategory($occupationalCategory) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('occupationalCategory', $occupationalCategory); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Specific qualifications required for this role or Occupation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $qualifications * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/qualifications */ - public function mainEntityOfPage($mainEntityOfPage) + public function qualifications($qualifications) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('qualifications', $qualifications); } /** - * The name of the item. + * Responsibilities associated with this role or Occupation. * - * @param string|string[] $name + * @param string|string[] $responsibilities * * @return static * - * @see http://schema.org/name + * @see http://schema.org/responsibilities */ - public function name($name) + public function responsibilities($responsibilities) { - return $this->setProperty('name', $name); + return $this->setProperty('responsibilities', $responsibilities); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * 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. * - * @param Action|Action[] $potentialAction + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/sameAs */ - public function potentialAction($potentialAction) + public function sameAs($sameAs) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('sameAs', $sameAs); } /** - * 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. + * Skills required to fulfill this role or in this Occupation. * - * @param string|string[] $sameAs + * @param string|string[] $skills * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/skills */ - public function sameAs($sameAs) + public function skills($skills) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('skills', $skills); } /** diff --git a/src/OceanBodyOfWater.php b/src/OceanBodyOfWater.php index 5a5d79c5a..8eb4dc36b 100644 --- a/src/OceanBodyOfWater.php +++ b/src/OceanBodyOfWater.php @@ -37,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -66,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -146,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -234,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -308,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -350,6 +463,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -392,6 +519,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -435,6 +577,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -482,189 +640,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Offer.php b/src/Offer.php index 38039477a..55423d369 100644 --- a/src/Offer.php +++ b/src/Offer.php @@ -53,6 +53,25 @@ public function addOn($addOn) return $this->setProperty('addOn', $addOn); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The amount of time that is required between accepting the offer and the * actual usage of the resource or service. @@ -83,6 +102,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -217,6 +250,37 @@ public function deliveryLeadTime($deliveryLeadTime) return $this->setProperty('deliveryLeadTime', $deliveryLeadTime); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The type(s) of customers for which the given offer is valid. * @@ -369,6 +433,39 @@ public function gtin8($gtin8) return $this->setProperty('gtin8', $gtin8); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * This links to a node or nodes indicating the exact quantity of the * products included in the offer. @@ -447,6 +544,22 @@ public function itemOffered($itemOffered) return $this->setProperty('itemOffered', $itemOffered); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The Manufacturer Part Number (MPN) of the product, or the product to * which the offer refers. @@ -462,6 +575,35 @@ public function mpn($mpn) return $this->setProperty('mpn', $mpn); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The offer price of a product, or of a price component when attached to * PriceSpecification and its subtypes. @@ -579,6 +721,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * An entity which offers (sells / leases / lends / loans) the services / * goods. A seller may also be a provider. @@ -626,232 +784,74 @@ public function sku($sku) } /** - * The date when the item becomes valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom - * - * @return static - * - * @see http://schema.org/validFrom - */ - public function validFrom($validFrom) - { - return $this->setProperty('validFrom', $validFrom); - } - - /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough - * - * @return static - * - * @see http://schema.org/validThrough - */ - public function validThrough($validThrough) - { - return $this->setProperty('validThrough', $validThrough); - } - - /** - * The warranty promise(s) included in the offer. - * - * @param WarrantyPromise|WarrantyPromise[] $warranty - * - * @return static - * - * @see http://schema.org/warranty - */ - public function warranty($warranty) - { - return $this->setProperty('warranty', $warranty); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The date when the item becomes valid. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validFrom */ - public function sameAs($sameAs) + public function validFrom($validFrom) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validFrom', $validFrom); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * The warranty promise(s) included in the offer. * - * @param string|string[] $url + * @param WarrantyPromise|WarrantyPromise[] $warranty * * @return static * - * @see http://schema.org/url + * @see http://schema.org/warranty */ - public function url($url) + public function warranty($warranty) { - return $this->setProperty('url', $url); + return $this->setProperty('warranty', $warranty); } } diff --git a/src/OfferCatalog.php b/src/OfferCatalog.php index 8321f7862..2e0f68f14 100644 --- a/src/OfferCatalog.php +++ b/src/OfferCatalog.php @@ -15,61 +15,6 @@ */ class OfferCatalog extends BaseType implements ItemListContract, IntangibleContract, ThingContract { - /** - * For itemListElement values, you can use simple strings (e.g. "Peter", - * "Paul", "Mary"), existing entities, or use ListItem. - * - * Text values are best if the elements in the list are plain strings. - * Existing entities are best for a simple, unordered list of existing - * things in your data. ListItem is used with ordered lists when you want to - * provide additional context about the element in that list or when the - * same item might be in different places in different lists. - * - * Note: The order of elements in your mark-up is not sufficient for - * indicating the order or elements. Use ListItem with a 'position' - * property in such cases. - * - * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement - * - * @return static - * - * @see http://schema.org/itemListElement - */ - public function itemListElement($itemListElement) - { - return $this->setProperty('itemListElement', $itemListElement); - } - - /** - * Type of ordering (e.g. Ascending, Descending, Unordered). - * - * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder - * - * @return static - * - * @see http://schema.org/itemListOrder - */ - public function itemListOrder($itemListOrder) - { - return $this->setProperty('itemListOrder', $itemListOrder); - } - - /** - * The number of items in an ItemList. Note that some descriptions might not - * fully describe all items in a list (e.g., multi-page pagination); in such - * cases, the numberOfItems would be for the entire list. - * - * @param int|int[] $numberOfItems - * - * @return static - * - * @see http://schema.org/numberOfItems - */ - public function numberOfItems($numberOfItems) - { - return $this->setProperty('numberOfItems', $numberOfItems); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -167,6 +112,45 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * For itemListElement values, you can use simple strings (e.g. "Peter", + * "Paul", "Mary"), existing entities, or use ListItem. + * + * Text values are best if the elements in the list are plain strings. + * Existing entities are best for a simple, unordered list of existing + * things in your data. ListItem is used with ordered lists when you want to + * provide additional context about the element in that list or when the + * same item might be in different places in different lists. + * + * Note: The order of elements in your mark-up is not sufficient for + * indicating the order or elements. Use ListItem with a 'position' + * property in such cases. + * + * @param ListItem|ListItem[]|Thing|Thing[]|string|string[] $itemListElement + * + * @return static + * + * @see http://schema.org/itemListElement + */ + public function itemListElement($itemListElement) + { + return $this->setProperty('itemListElement', $itemListElement); + } + + /** + * Type of ordering (e.g. Ascending, Descending, Unordered). + * + * @param ItemListOrderType|ItemListOrderType[]|string|string[] $itemListOrder + * + * @return static + * + * @see http://schema.org/itemListOrder + */ + public function itemListOrder($itemListOrder) + { + return $this->setProperty('itemListOrder', $itemListOrder); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -197,6 +181,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The number of items in an ItemList. Note that some descriptions might not + * fully describe all items in a list (e.g., multi-page pagination); in such + * cases, the numberOfItems would be for the entire list. + * + * @param int|int[] $numberOfItems + * + * @return static + * + * @see http://schema.org/numberOfItems + */ + public function numberOfItems($numberOfItems) + { + return $this->setProperty('numberOfItems', $numberOfItems); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/OfficeEquipmentStore.php b/src/OfficeEquipmentStore.php index 6c30c8ae1..1380d72ce 100644 --- a/src/OfficeEquipmentStore.php +++ b/src/OfficeEquipmentStore.php @@ -17,126 +17,104 @@ class OfficeEquipmentStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/OnDemandEvent.php b/src/OnDemandEvent.php index 0156d941c..6d6020a3a 100644 --- a/src/OnDemandEvent.php +++ b/src/OnDemandEvent.php @@ -15,48 +15,6 @@ */ class OnDemandEvent extends BaseType implements PublicationEventContract, EventContract, ThingContract { - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $free - * - * @return static - * - * @see http://schema.org/free - */ - public function free($free) - { - return $this->setProperty('free', $free); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * A broadcast service associated with the publication event. - * - * @param BroadcastService|BroadcastService[] $publishedOn - * - * @return static - * - * @see http://schema.org/publishedOn - */ - public function publishedOn($publishedOn) - { - return $this->setProperty('publishedOn', $publishedOn); - } - /** * The subject matter of the content. * @@ -87,6 +45,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -102,6 +79,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -173,6 +164,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -189,6 +194,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -248,6 +270,20 @@ public function eventStatus($eventStatus) return $this->setProperty('eventStatus', $eventStatus); } + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $free + * + * @return static + * + * @see http://schema.org/free + */ + public function free($free) + { + return $this->setProperty('free', $free); + } + /** * A person or organization that supports (sponsors) something through some * kind of financial contribution. @@ -263,6 +299,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -280,6 +349,20 @@ public function inLanguage($inLanguage) return $this->setProperty('inLanguage', $inLanguage); } + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The location of for example where the event is happening, an organization * is located, or where an action takes place. @@ -295,6 +378,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -309,6 +408,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -369,6 +482,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -387,6 +515,20 @@ public function previousStartDate($previousStartDate) return $this->setProperty('previousStartDate', $previousStartDate); } + /** + * A broadcast service associated with the publication event. + * + * @param BroadcastService|BroadcastService[] $publishedOn + * + * @return static + * + * @see http://schema.org/publishedOn + */ + public function publishedOn($publishedOn) + { + return $this->setProperty('publishedOn', $publishedOn); + } + /** * The CreativeWork that captured all or part of this Event. * @@ -429,6 +571,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -491,6 +649,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -537,6 +709,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -568,190 +754,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/OpeningHoursSpecification.php b/src/OpeningHoursSpecification.php index 668a68455..ee70b5627 100644 --- a/src/OpeningHoursSpecification.php +++ b/src/OpeningHoursSpecification.php @@ -23,107 +23,64 @@ class OpeningHoursSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** - * The closing hour of the place or service on the given day(s) of the week. - * - * @param \DateTimeInterface|\DateTimeInterface[] $closes - * - * @return static - * - * @see http://schema.org/closes - */ - public function closes($closes) - { - return $this->setProperty('closes', $closes); - } - - /** - * The day of the week for which these opening hours are valid. - * - * @param DayOfWeek|DayOfWeek[] $dayOfWeek - * - * @return static - * - * @see http://schema.org/dayOfWeek - */ - public function dayOfWeek($dayOfWeek) - { - return $this->setProperty('dayOfWeek', $dayOfWeek); - } - - /** - * The opening hour of the place or service on the given day(s) of the week. - * - * @param \DateTimeInterface|\DateTimeInterface[] $opens - * - * @return static - * - * @see http://schema.org/opens - */ - public function opens($opens) - { - return $this->setProperty('opens', $opens); - } - - /** - * The date when the item becomes valid. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/validFrom + * @see http://schema.org/additionalType */ - public function validFrom($validFrom) + public function additionalType($additionalType) { - return $this->setProperty('validFrom', $validFrom); + return $this->setProperty('additionalType', $additionalType); } /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/validThrough + * @see http://schema.org/alternateName */ - public function validThrough($validThrough) + public function alternateName($alternateName) { - return $this->setProperty('validThrough', $validThrough); + return $this->setProperty('alternateName', $alternateName); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The closing hour of the place or service on the given day(s) of the week. * - * @param string|string[] $additionalType + * @param \DateTimeInterface|\DateTimeInterface[] $closes * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/closes */ - public function additionalType($additionalType) + public function closes($closes) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('closes', $closes); } /** - * An alias for the item. + * The day of the week for which these opening hours are valid. * - * @param string|string[] $alternateName + * @param DayOfWeek|DayOfWeek[] $dayOfWeek * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/dayOfWeek */ - public function alternateName($alternateName) + public function dayOfWeek($dayOfWeek) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('dayOfWeek', $dayOfWeek); } /** @@ -220,6 +177,20 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The opening hour of the place or service on the given day(s) of the week. + * + * @param \DateTimeInterface|\DateTimeInterface[] $opens + * + * @return static + * + * @see http://schema.org/opens + */ + public function opens($opens) + { + return $this->setProperty('opens', $opens); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -279,4 +250,33 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * + * @return static + * + * @see http://schema.org/validThrough + */ + public function validThrough($validThrough) + { + return $this->setProperty('validThrough', $validThrough); + } + } diff --git a/src/Order.php b/src/Order.php index b76b658af..6007d0823 100644 --- a/src/Order.php +++ b/src/Order.php @@ -30,6 +30,39 @@ public function acceptedOffer($acceptedOffer) return $this->setProperty('acceptedOffer', $acceptedOffer); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The billing address for the order. * @@ -89,6 +122,37 @@ public function customer($customer) return $this->setProperty('customer', $customer); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Any discount applied (to an Order). * @@ -139,6 +203,39 @@ public function discountCurrency($discountCurrency) return $this->setProperty('discountCurrency', $discountCurrency); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * Was the offer accepted as a gift for someone other than the buyer. * @@ -153,6 +250,22 @@ public function isGift($isGift) return $this->setProperty('isGift', $isGift); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * 'merchant' is an out-dated term for 'seller'. * @@ -167,6 +280,20 @@ public function merchant($merchant) return $this->setProperty('merchant', $merchant); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * Date order was placed. * @@ -322,148 +449,6 @@ public function paymentUrl($paymentUrl) return $this->setProperty('paymentUrl', $paymentUrl); } - /** - * An entity which offers (sells / leases / lends / loans) the services / - * goods. A seller may also be a provider. - * - * @param Organization|Organization[]|Person|Person[] $seller - * - * @return static - * - * @see http://schema.org/seller - */ - public function seller($seller) - { - return $this->setProperty('seller', $seller); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -495,6 +480,21 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * An entity which offers (sells / leases / lends / loans) the services / + * goods. A seller may also be a provider. + * + * @param Organization|Organization[]|Person|Person[] $seller + * + * @return static + * + * @see http://schema.org/seller + */ + public function seller($seller) + { + return $this->setProperty('seller', $seller); + } + /** * A CreativeWork or Event about this Thing. * diff --git a/src/OrderAction.php b/src/OrderAction.php index faefb6536..0a227996a 100644 --- a/src/OrderAction.php +++ b/src/OrderAction.php @@ -15,121 +15,110 @@ class OrderAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * A sub property of instrument. The method of delivery. + * Indicates the current disposition of the Action. * - * @param DeliveryMethod|DeliveryMethod[] $deliveryMethod + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/deliveryMethod + * @see http://schema.org/actionStatus */ - public function deliveryMethod($deliveryMethod) + public function actionStatus($actionStatus) { - return $this->setProperty('deliveryMethod', $deliveryMethod); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param float|float[]|int|int[]|string|string[] $price + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/price + * @see http://schema.org/additionalType */ - public function price($price) + public function additionalType($additionalType) { - return $this->setProperty('price', $price); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param string|string[] $priceCurrency + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/agent */ - public function priceCurrency($priceCurrency) + public function agent($agent) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('agent', $agent); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * An alias for the item. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/alternateName */ - public function priceSpecification($priceSpecification) + public function alternateName($alternateName) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A sub property of instrument. The method of delivery. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param DeliveryMethod|DeliveryMethod[] $deliveryMethod * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/deliveryMethod */ - public function actionStatus($actionStatus) + public function deliveryMethod($deliveryMethod) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('deliveryMethod', $deliveryMethod); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -170,288 +159,299 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/instrument */ - public function participant($participant) + public function instrument($instrument) { - return $this->setProperty('participant', $participant); + return $this->setProperty('instrument', $instrument); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Thing|Thing[] $result + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/result + * @see http://schema.org/location */ - public function result($result) + public function location($location) { - return $this->setProperty('result', $result); + return $this->setProperty('location', $location); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/mainEntityOfPage */ - public function startTime($startTime) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Indicates a target EntryPoint for an Action. + * The name of the item. * - * @param EntryPoint|EntryPoint[] $target + * @param string|string[] $name * * @return static * - * @see http://schema.org/target + * @see http://schema.org/name */ - public function target($target) + public function name($name) { - return $this->setProperty('target', $target); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/object */ - public function additionalType($additionalType) + public function object($object) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('object', $object); } /** - * An alias for the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/participant */ - public function alternateName($alternateName) + public function participant($participant) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('participant', $participant); } /** - * A description of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $description + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/description + * @see http://schema.org/potentialAction */ - public function description($description) + public function potentialAction($potentialAction) { - return $this->setProperty('description', $description); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $disambiguatingDescription + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/price */ - public function disambiguatingDescription($disambiguatingDescription) + public function price($price) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('price', $price); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceCurrency */ - public function identifier($identifier) + public function priceCurrency($priceCurrency) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceSpecification */ - public function image($image) + public function priceSpecification($priceSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/OrderItem.php b/src/OrderItem.php index 8c4a86285..8b98b503b 100644 --- a/src/OrderItem.php +++ b/src/OrderItem.php @@ -14,77 +14,6 @@ */ class OrderItem extends BaseType implements IntangibleContract, ThingContract { - /** - * The delivery of the parcel related to this order or order item. - * - * @param ParcelDelivery|ParcelDelivery[] $orderDelivery - * - * @return static - * - * @see http://schema.org/orderDelivery - */ - public function orderDelivery($orderDelivery) - { - return $this->setProperty('orderDelivery', $orderDelivery); - } - - /** - * The identifier of the order item. - * - * @param string|string[] $orderItemNumber - * - * @return static - * - * @see http://schema.org/orderItemNumber - */ - public function orderItemNumber($orderItemNumber) - { - return $this->setProperty('orderItemNumber', $orderItemNumber); - } - - /** - * The current status of the order item. - * - * @param OrderStatus|OrderStatus[] $orderItemStatus - * - * @return static - * - * @see http://schema.org/orderItemStatus - */ - public function orderItemStatus($orderItemStatus) - { - return $this->setProperty('orderItemStatus', $orderItemStatus); - } - - /** - * The number of the item ordered. If the property is not set, assume the - * quantity is one. - * - * @param float|float[]|int|int[] $orderQuantity - * - * @return static - * - * @see http://schema.org/orderQuantity - */ - public function orderQuantity($orderQuantity) - { - return $this->setProperty('orderQuantity', $orderQuantity); - } - - /** - * The item ordered. - * - * @param OrderItem|OrderItem[]|Product|Product[]|Service|Service[] $orderedItem - * - * @return static - * - * @see http://schema.org/orderedItem - */ - public function orderedItem($orderedItem) - { - return $this->setProperty('orderedItem', $orderedItem); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -212,6 +141,77 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The delivery of the parcel related to this order or order item. + * + * @param ParcelDelivery|ParcelDelivery[] $orderDelivery + * + * @return static + * + * @see http://schema.org/orderDelivery + */ + public function orderDelivery($orderDelivery) + { + return $this->setProperty('orderDelivery', $orderDelivery); + } + + /** + * The identifier of the order item. + * + * @param string|string[] $orderItemNumber + * + * @return static + * + * @see http://schema.org/orderItemNumber + */ + public function orderItemNumber($orderItemNumber) + { + return $this->setProperty('orderItemNumber', $orderItemNumber); + } + + /** + * The current status of the order item. + * + * @param OrderStatus|OrderStatus[] $orderItemStatus + * + * @return static + * + * @see http://schema.org/orderItemStatus + */ + public function orderItemStatus($orderItemStatus) + { + return $this->setProperty('orderItemStatus', $orderItemStatus); + } + + /** + * The number of the item ordered. If the property is not set, assume the + * quantity is one. + * + * @param float|float[]|int|int[] $orderQuantity + * + * @return static + * + * @see http://schema.org/orderQuantity + */ + public function orderQuantity($orderQuantity) + { + return $this->setProperty('orderQuantity', $orderQuantity); + } + + /** + * The item ordered. + * + * @param OrderItem|OrderItem[]|Product|Product[]|Service|Service[] $orderedItem + * + * @return static + * + * @see http://schema.org/orderedItem + */ + public function orderedItem($orderedItem) + { + return $this->setProperty('orderedItem', $orderedItem); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/Organization.php b/src/Organization.php index 072465088..5a96c07fc 100644 --- a/src/Organization.php +++ b/src/Organization.php @@ -181,6 +181,25 @@ class Organization extends BaseType implements ThingContract */ const rNews = 'http://www.w3.org/wiki/WebSchemas/SchemaDotOrgSources#source_rNews'; + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -210,6 +229,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -312,6 +345,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -543,6 +607,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -617,6 +714,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -690,6 +803,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -747,6 +874,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -799,6 +941,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -874,6 +1032,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -904,203 +1076,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/OrganizationRole.php b/src/OrganizationRole.php index 8bfa04518..27d9c1cf9 100644 --- a/src/OrganizationRole.php +++ b/src/OrganizationRole.php @@ -14,84 +14,6 @@ */ class OrganizationRole extends BaseType implements RoleContract, IntangibleContract, ThingContract { - /** - * A number associated with a role in an organization, for example, the - * number on an athlete's jersey. - * - * @param float|float[]|int|int[] $numberedPosition - * - * @return static - * - * @see http://schema.org/numberedPosition - */ - public function numberedPosition($numberedPosition) - { - return $this->setProperty('numberedPosition', $numberedPosition); - } - - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * A position played, performed or filled by a person or organization, as - * part of an organization. For example, an athlete in a SportsTeam might - * play in the position named 'Quarterback'. - * - * @param string|string[] $namedPosition - * - * @return static - * - * @see http://schema.org/namedPosition - */ - public function namedPosition($namedPosition) - { - return $this->setProperty('namedPosition', $namedPosition); - } - - /** - * A role played, performed or filled by a person or organization. For - * example, the team of creators for a comic book might fill the roles named - * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might - * play in the position named 'Quarterback'. - * - * @param string|string[] $roleName - * - * @return static - * - * @see http://schema.org/roleName - */ - public function roleName($roleName) - { - return $this->setProperty('roleName', $roleName); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -156,6 +78,21 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -219,6 +156,37 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A position played, performed or filled by a person or organization, as + * part of an organization. For example, an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $namedPosition + * + * @return static + * + * @see http://schema.org/namedPosition + */ + public function namedPosition($namedPosition) + { + return $this->setProperty('namedPosition', $namedPosition); + } + + /** + * A number associated with a role in an organization, for example, the + * number on an athlete's jersey. + * + * @param float|float[]|int|int[] $numberedPosition + * + * @return static + * + * @see http://schema.org/numberedPosition + */ + public function numberedPosition($numberedPosition) + { + return $this->setProperty('numberedPosition', $numberedPosition); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -234,6 +202,23 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A role played, performed or filled by a person or organization. For + * example, the team of creators for a comic book might fill the roles named + * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $roleName + * + * @return static + * + * @see http://schema.org/roleName + */ + public function roleName($roleName) + { + return $this->setProperty('roleName', $roleName); + } + /** * 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 @@ -250,6 +235,21 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + /** * A CreativeWork or Event about this Thing. * diff --git a/src/OrganizeAction.php b/src/OrganizeAction.php index 26463ee11..64164beb6 100644 --- a/src/OrganizeAction.php +++ b/src/OrganizeAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/OutletStore.php b/src/OutletStore.php index 7a6f5e857..00afd6ffc 100644 --- a/src/OutletStore.php +++ b/src/OutletStore.php @@ -17,126 +17,104 @@ class OutletStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/OwnershipInfo.php b/src/OwnershipInfo.php index 29adff67c..e7b774d09 100644 --- a/src/OwnershipInfo.php +++ b/src/OwnershipInfo.php @@ -29,48 +29,6 @@ public function acquiredFrom($acquiredFrom) return $this->setProperty('acquiredFrom', $acquiredFrom); } - /** - * The date and time of obtaining the product. - * - * @param \DateTimeInterface|\DateTimeInterface[] $ownedFrom - * - * @return static - * - * @see http://schema.org/ownedFrom - */ - public function ownedFrom($ownedFrom) - { - return $this->setProperty('ownedFrom', $ownedFrom); - } - - /** - * The date and time of giving up ownership on the product. - * - * @param \DateTimeInterface|\DateTimeInterface[] $ownedThrough - * - * @return static - * - * @see http://schema.org/ownedThrough - */ - public function ownedThrough($ownedThrough) - { - return $this->setProperty('ownedThrough', $ownedThrough); - } - - /** - * The product that this structured value is referring to. - * - * @param Product|Product[]|Service|Service[] $typeOfGood - * - * @return static - * - * @see http://schema.org/typeOfGood - */ - public function typeOfGood($typeOfGood) - { - return $this->setProperty('typeOfGood', $typeOfGood); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -198,6 +156,34 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The date and time of obtaining the product. + * + * @param \DateTimeInterface|\DateTimeInterface[] $ownedFrom + * + * @return static + * + * @see http://schema.org/ownedFrom + */ + public function ownedFrom($ownedFrom) + { + return $this->setProperty('ownedFrom', $ownedFrom); + } + + /** + * The date and time of giving up ownership on the product. + * + * @param \DateTimeInterface|\DateTimeInterface[] $ownedThrough + * + * @return static + * + * @see http://schema.org/ownedThrough + */ + public function ownedThrough($ownedThrough) + { + return $this->setProperty('ownedThrough', $ownedThrough); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -243,6 +229,20 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The product that this structured value is referring to. + * + * @param Product|Product[]|Service|Service[] $typeOfGood + * + * @return static + * + * @see http://schema.org/typeOfGood + */ + public function typeOfGood($typeOfGood) + { + return $this->setProperty('typeOfGood', $typeOfGood); + } + /** * URL of the item. * diff --git a/src/PaintAction.php b/src/PaintAction.php index 271863788..860ae93f4 100644 --- a/src/PaintAction.php +++ b/src/PaintAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Painting.php b/src/Painting.php index ca8867de0..99797ac87 100644 --- a/src/Painting.php +++ b/src/Painting.php @@ -157,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -172,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -463,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -688,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -885,6 +982,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -915,6 +1028,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -945,6 +1072,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1086,6 +1228,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1168,6 +1326,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1289,6 +1461,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1332,190 +1518,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ParcelDelivery.php b/src/ParcelDelivery.php index eea168a13..67c9ba895 100644 --- a/src/ParcelDelivery.php +++ b/src/ParcelDelivery.php @@ -15,347 +15,347 @@ class ParcelDelivery extends BaseType implements IntangibleContract, ThingContract { /** - * 'carrier' is an out-dated term indicating the 'provider' for parcel - * delivery and flights. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $carrier + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/carrier + * @see http://schema.org/additionalType */ - public function carrier($carrier) + public function additionalType($additionalType) { - return $this->setProperty('carrier', $carrier); + return $this->setProperty('additionalType', $additionalType); } /** - * Destination address. + * An alias for the item. * - * @param PostalAddress|PostalAddress[] $deliveryAddress + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/deliveryAddress + * @see http://schema.org/alternateName */ - public function deliveryAddress($deliveryAddress) + public function alternateName($alternateName) { - return $this->setProperty('deliveryAddress', $deliveryAddress); + return $this->setProperty('alternateName', $alternateName); } /** - * New entry added as the package passes through each leg of its journey - * (from shipment to final delivery). + * 'carrier' is an out-dated term indicating the 'provider' for parcel + * delivery and flights. * - * @param DeliveryEvent|DeliveryEvent[] $deliveryStatus + * @param Organization|Organization[] $carrier * * @return static * - * @see http://schema.org/deliveryStatus + * @see http://schema.org/carrier */ - public function deliveryStatus($deliveryStatus) + public function carrier($carrier) { - return $this->setProperty('deliveryStatus', $deliveryStatus); + return $this->setProperty('carrier', $carrier); } /** - * The earliest date the package may arrive. + * Destination address. * - * @param \DateTimeInterface|\DateTimeInterface[] $expectedArrivalFrom + * @param PostalAddress|PostalAddress[] $deliveryAddress * * @return static * - * @see http://schema.org/expectedArrivalFrom + * @see http://schema.org/deliveryAddress */ - public function expectedArrivalFrom($expectedArrivalFrom) + public function deliveryAddress($deliveryAddress) { - return $this->setProperty('expectedArrivalFrom', $expectedArrivalFrom); + return $this->setProperty('deliveryAddress', $deliveryAddress); } /** - * The latest date the package may arrive. + * New entry added as the package passes through each leg of its journey + * (from shipment to final delivery). * - * @param \DateTimeInterface|\DateTimeInterface[] $expectedArrivalUntil + * @param DeliveryEvent|DeliveryEvent[] $deliveryStatus * * @return static * - * @see http://schema.org/expectedArrivalUntil + * @see http://schema.org/deliveryStatus */ - public function expectedArrivalUntil($expectedArrivalUntil) + public function deliveryStatus($deliveryStatus) { - return $this->setProperty('expectedArrivalUntil', $expectedArrivalUntil); + return $this->setProperty('deliveryStatus', $deliveryStatus); } /** - * Method used for delivery or shipping. + * A description of the item. * - * @param DeliveryMethod|DeliveryMethod[] $hasDeliveryMethod + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasDeliveryMethod + * @see http://schema.org/description */ - public function hasDeliveryMethod($hasDeliveryMethod) + public function description($description) { - return $this->setProperty('hasDeliveryMethod', $hasDeliveryMethod); + return $this->setProperty('description', $description); } /** - * Item(s) being shipped. + * 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. * - * @param Product|Product[] $itemShipped + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/itemShipped + * @see http://schema.org/disambiguatingDescription */ - public function itemShipped($itemShipped) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('itemShipped', $itemShipped); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Shipper's address. + * The earliest date the package may arrive. * - * @param PostalAddress|PostalAddress[] $originAddress + * @param \DateTimeInterface|\DateTimeInterface[] $expectedArrivalFrom * * @return static * - * @see http://schema.org/originAddress + * @see http://schema.org/expectedArrivalFrom */ - public function originAddress($originAddress) + public function expectedArrivalFrom($expectedArrivalFrom) { - return $this->setProperty('originAddress', $originAddress); + return $this->setProperty('expectedArrivalFrom', $expectedArrivalFrom); } /** - * The overall order the items in this delivery were included in. + * The latest date the package may arrive. * - * @param Order|Order[] $partOfOrder + * @param \DateTimeInterface|\DateTimeInterface[] $expectedArrivalUntil * * @return static * - * @see http://schema.org/partOfOrder + * @see http://schema.org/expectedArrivalUntil */ - public function partOfOrder($partOfOrder) + public function expectedArrivalUntil($expectedArrivalUntil) { - return $this->setProperty('partOfOrder', $partOfOrder); + return $this->setProperty('expectedArrivalUntil', $expectedArrivalUntil); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * Method used for delivery or shipping. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param DeliveryMethod|DeliveryMethod[] $hasDeliveryMethod * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/hasDeliveryMethod */ - public function provider($provider) + public function hasDeliveryMethod($hasDeliveryMethod) { - return $this->setProperty('provider', $provider); + return $this->setProperty('hasDeliveryMethod', $hasDeliveryMethod); } /** - * Shipper tracking number. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $trackingNumber + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/trackingNumber + * @see http://schema.org/identifier */ - public function trackingNumber($trackingNumber) + public function identifier($identifier) { - return $this->setProperty('trackingNumber', $trackingNumber); + return $this->setProperty('identifier', $identifier); } /** - * Tracking url for the parcel delivery. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $trackingUrl + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/trackingUrl + * @see http://schema.org/image */ - public function trackingUrl($trackingUrl) + public function image($image) { - return $this->setProperty('trackingUrl', $trackingUrl); + return $this->setProperty('image', $image); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Item(s) being shipped. * - * @param string|string[] $additionalType + * @param Product|Product[] $itemShipped * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/itemShipped */ - public function additionalType($additionalType) + public function itemShipped($itemShipped) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('itemShipped', $itemShipped); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * Shipper's address. * - * @param string|string[] $disambiguatingDescription + * @param PostalAddress|PostalAddress[] $originAddress * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/originAddress */ - public function disambiguatingDescription($disambiguatingDescription) + public function originAddress($originAddress) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('originAddress', $originAddress); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The overall order the items in this delivery were included in. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Order|Order[] $partOfOrder * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/partOfOrder */ - public function identifier($identifier) + public function partOfOrder($partOfOrder) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('partOfOrder', $partOfOrder); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/provider */ - public function mainEntityOfPage($mainEntityOfPage) + public function provider($provider) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('provider', $provider); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Shipper tracking number. * - * @param string|string[] $sameAs + * @param string|string[] $trackingNumber * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/trackingNumber */ - public function sameAs($sameAs) + public function trackingNumber($trackingNumber) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('trackingNumber', $trackingNumber); } /** - * A CreativeWork or Event about this Thing. + * Tracking url for the parcel delivery. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $trackingUrl * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/trackingUrl */ - public function subjectOf($subjectOf) + public function trackingUrl($trackingUrl) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('trackingUrl', $trackingUrl); } /** diff --git a/src/ParentAudience.php b/src/ParentAudience.php index 79f6d20bc..6f10da5fa 100644 --- a/src/ParentAudience.php +++ b/src/ParentAudience.php @@ -17,115 +17,36 @@ class ParentAudience extends BaseType implements PeopleAudienceContract, AudienceContract, IntangibleContract, ThingContract { /** - * Maximal age of the child. - * - * @param float|float[]|int|int[] $childMaxAge - * - * @return static - * - * @see http://schema.org/childMaxAge - */ - public function childMaxAge($childMaxAge) - { - return $this->setProperty('childMaxAge', $childMaxAge); - } - - /** - * Minimal age of the child. - * - * @param float|float[]|int|int[] $childMinAge - * - * @return static - * - * @see http://schema.org/childMinAge - */ - public function childMinAge($childMinAge) - { - return $this->setProperty('childMinAge', $childMinAge); - } - - /** - * Audiences defined by a person's gender. - * - * @param string|string[] $requiredGender - * - * @return static - * - * @see http://schema.org/requiredGender - */ - public function requiredGender($requiredGender) - { - return $this->setProperty('requiredGender', $requiredGender); - } - - /** - * Audiences defined by a person's maximum age. - * - * @param int|int[] $requiredMaxAge - * - * @return static - * - * @see http://schema.org/requiredMaxAge - */ - public function requiredMaxAge($requiredMaxAge) - { - return $this->setProperty('requiredMaxAge', $requiredMaxAge); - } - - /** - * Audiences defined by a person's minimum age. - * - * @param int|int[] $requiredMinAge - * - * @return static - * - * @see http://schema.org/requiredMinAge - */ - public function requiredMinAge($requiredMinAge) - { - return $this->setProperty('requiredMinAge', $requiredMinAge); - } - - /** - * The gender of the person or audience. - * - * @param string|string[] $suggestedGender - * - * @return static - * - * @see http://schema.org/suggestedGender - */ - public function suggestedGender($suggestedGender) - { - return $this->setProperty('suggestedGender', $suggestedGender); - } - - /** - * Maximal age recommended for viewing content. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param float|float[]|int|int[] $suggestedMaxAge + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/suggestedMaxAge + * @see http://schema.org/additionalType */ - public function suggestedMaxAge($suggestedMaxAge) + public function additionalType($additionalType) { - return $this->setProperty('suggestedMaxAge', $suggestedMaxAge); + return $this->setProperty('additionalType', $additionalType); } /** - * Minimal age recommended for viewing content. + * An alias for the item. * - * @param float|float[]|int|int[] $suggestedMinAge + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/suggestedMinAge + * @see http://schema.org/alternateName */ - public function suggestedMinAge($suggestedMinAge) + public function alternateName($alternateName) { - return $this->setProperty('suggestedMinAge', $suggestedMinAge); + return $this->setProperty('alternateName', $alternateName); } /** @@ -144,50 +65,31 @@ public function audienceType($audienceType) } /** - * The geographic area associated with the audience. - * - * @param AdministrativeArea|AdministrativeArea[] $geographicArea - * - * @return static - * - * @see http://schema.org/geographicArea - */ - public function geographicArea($geographicArea) - { - return $this->setProperty('geographicArea', $geographicArea); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Maximal age of the child. * - * @param string|string[] $additionalType + * @param float|float[]|int|int[] $childMaxAge * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/childMaxAge */ - public function additionalType($additionalType) + public function childMaxAge($childMaxAge) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('childMaxAge', $childMaxAge); } /** - * An alias for the item. + * Minimal age of the child. * - * @param string|string[] $alternateName + * @param float|float[]|int|int[] $childMinAge * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/childMinAge */ - public function alternateName($alternateName) + public function childMinAge($childMinAge) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('childMinAge', $childMinAge); } /** @@ -221,6 +123,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -299,6 +215,48 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * Audiences defined by a person's gender. + * + * @param string|string[] $requiredGender + * + * @return static + * + * @see http://schema.org/requiredGender + */ + public function requiredGender($requiredGender) + { + return $this->setProperty('requiredGender', $requiredGender); + } + + /** + * Audiences defined by a person's maximum age. + * + * @param int|int[] $requiredMaxAge + * + * @return static + * + * @see http://schema.org/requiredMaxAge + */ + public function requiredMaxAge($requiredMaxAge) + { + return $this->setProperty('requiredMaxAge', $requiredMaxAge); + } + + /** + * Audiences defined by a person's minimum age. + * + * @param int|int[] $requiredMinAge + * + * @return static + * + * @see http://schema.org/requiredMinAge + */ + public function requiredMinAge($requiredMinAge) + { + return $this->setProperty('requiredMinAge', $requiredMinAge); + } + /** * 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 @@ -329,6 +287,48 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The gender of the person or audience. + * + * @param string|string[] $suggestedGender + * + * @return static + * + * @see http://schema.org/suggestedGender + */ + public function suggestedGender($suggestedGender) + { + return $this->setProperty('suggestedGender', $suggestedGender); + } + + /** + * Maximal age recommended for viewing content. + * + * @param float|float[]|int|int[] $suggestedMaxAge + * + * @return static + * + * @see http://schema.org/suggestedMaxAge + */ + public function suggestedMaxAge($suggestedMaxAge) + { + return $this->setProperty('suggestedMaxAge', $suggestedMaxAge); + } + + /** + * Minimal age recommended for viewing content. + * + * @param float|float[]|int|int[] $suggestedMinAge + * + * @return static + * + * @see http://schema.org/suggestedMinAge + */ + public function suggestedMinAge($suggestedMinAge) + { + return $this->setProperty('suggestedMinAge', $suggestedMinAge); + } + /** * URL of the item. * diff --git a/src/Park.php b/src/Park.php index 3cfd81566..b60440cb5 100644 --- a/src/Park.php +++ b/src/Park.php @@ -14,35 +14,6 @@ */ class Park extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/ParkingFacility.php b/src/ParkingFacility.php index 260808452..8255fc427 100644 --- a/src/ParkingFacility.php +++ b/src/ParkingFacility.php @@ -14,35 +14,6 @@ */ class ParkingFacility extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/PawnShop.php b/src/PawnShop.php index ea58a961e..c93ee6a70 100644 --- a/src/PawnShop.php +++ b/src/PawnShop.php @@ -18,126 +18,104 @@ class PawnShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -182,6 +160,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -225,6 +238,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -242,6 +320,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -428,22 +537,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -473,6 +610,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -489,6 +673,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -547,6 +746,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -561,6 +791,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -620,6 +892,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -648,6 +934,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -678,664 +1007,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/PayAction.php b/src/PayAction.php index 9b0582bf0..503e05141 100644 --- a/src/PayAction.php +++ b/src/PayAction.php @@ -15,122 +15,96 @@ class PayAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * Indicates the current disposition of the Action. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/actionStatus */ - public function recipient($recipient) + public function actionStatus($actionStatus) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param float|float[]|int|int[]|string|string[] $price + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/price + * @see http://schema.org/additionalType */ - public function price($price) + public function additionalType($additionalType) { - return $this->setProperty('price', $price); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param string|string[] $priceCurrency + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/agent */ - public function priceCurrency($priceCurrency) + public function agent($agent) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('agent', $agent); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * An alias for the item. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/alternateName */ - public function priceSpecification($priceSpecification) + public function alternateName($alternateName) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -171,288 +145,314 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $instrument + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/identifier */ - public function instrument($instrument) + public function identifier($identifier) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/object + * @see http://schema.org/instrument */ - public function object($object) + public function instrument($instrument) { - return $this->setProperty('object', $object); + return $this->setProperty('instrument', $instrument); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/location */ - public function participant($participant) + public function location($location) { - return $this->setProperty('participant', $participant); + return $this->setProperty('location', $location); } /** - * The result produced in the action. e.g. John wrote *a book*. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $result + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/result + * @see http://schema.org/mainEntityOfPage */ - public function result($result) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('result', $result); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The name of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param string|string[] $name * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/name */ - public function startTime($startTime) + public function name($name) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('name', $name); } /** - * Indicates a target EntryPoint for an Action. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/target + * @see http://schema.org/object */ - public function target($target) + public function object($object) { - return $this->setProperty('target', $target); + return $this->setProperty('object', $object); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/participant */ - public function additionalType($additionalType) + public function participant($participant) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('participant', $participant); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $description + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/description + * @see http://schema.org/price */ - public function description($description) + public function price($price) { - return $this->setProperty('description', $description); + return $this->setProperty('price', $price); } /** - * 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. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/priceCurrency */ - public function disambiguatingDescription($disambiguatingDescription) + public function priceCurrency($priceCurrency) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceSpecification */ - public function identifier($identifier) + public function priceSpecification($priceSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/PaymentCard.php b/src/PaymentCard.php index 5dc4e4f4e..9daebc0bd 100644 --- a/src/PaymentCard.php +++ b/src/PaymentCard.php @@ -18,65 +18,68 @@ class PaymentCard extends BaseType implements FinancialProductContract, PaymentMethodContract, EnumerationContract, IntangibleContract, ThingContract { /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/additionalType */ - public function annualPercentageRate($annualPercentageRate) + public function additionalType($additionalType) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('additionalType', $additionalType); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/aggregateRating */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function aggregateRating($aggregateRating) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/alternateName */ - public function interestRate($interestRate) + public function alternateName($alternateName) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/annualPercentageRate */ - public function aggregateRating($aggregateRating) + public function annualPercentageRate($annualPercentageRate) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -184,380 +187,377 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * A description of the item. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/description */ - public function hasOfferCatalog($hasOfferCatalog) + public function description($description) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('description', $description); } /** - * The hours during which this service or contact is available. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/disambiguatingDescription */ - public function hoursAvailable($hoursAvailable) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, somehow related product (or multiple products). + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param string|string[] $feesAndCommissionsSpecification * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/feesAndCommissionsSpecification */ - public function isRelatedTo($isRelatedTo) + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/hasOfferCatalog */ - public function isSimilarTo($isSimilarTo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An associated logo. + * The hours during which this service or contact is available. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hoursAvailable */ - public function logo($logo) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $offers + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/identifier */ - public function offers($offers) + public function identifier($identifier) { - return $this->setProperty('offers', $offers); + return $this->setProperty('identifier', $identifier); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $produces + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/image */ - public function produces($produces) + public function image($image) { - return $this->setProperty('produces', $produces); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/interestRate */ - public function provider($provider) + public function interestRate($interestRate) { - return $this->setProperty('provider', $provider); + return $this->setProperty('interestRate', $interestRate); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * A pointer to another, somehow related product (or multiple products). * - * @param string|string[] $providerMobility + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/isRelatedTo */ - public function providerMobility($providerMobility) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * A review of the item. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param Review|Review[] $review + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/isSimilarTo */ - public function review($review) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('review', $review); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * The geographic area where the service is provided. + * An associated logo. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/logo */ - public function serviceArea($serviceArea) + public function logo($logo) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('logo', $logo); } /** - * The audience eligible for this service. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Audience|Audience[] $serviceAudience + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/mainEntityOfPage */ - public function serviceAudience($serviceAudience) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * The name of the item. * - * @param Thing|Thing[] $serviceOutput + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/name */ - public function serviceOutput($serviceOutput) + public function name($name) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('name', $name); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param string|string[] $serviceType + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/offers */ - public function serviceType($serviceType) + public function offers($offers) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('offers', $offers); } /** - * A slogan or motto associated with the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $slogan + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/potentialAction */ - public function slogan($slogan) + public function potentialAction($potentialAction) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/produces */ - public function additionalType($additionalType) + public function produces($produces) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('produces', $produces); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $description + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/description + * @see http://schema.org/providerMobility */ - public function description($description) + public function providerMobility($providerMobility) { - return $this->setProperty('description', $description); + return $this->setProperty('providerMobility', $providerMobility); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** diff --git a/src/PaymentChargeSpecification.php b/src/PaymentChargeSpecification.php index 9482f3887..065a7f769 100644 --- a/src/PaymentChargeSpecification.php +++ b/src/PaymentChargeSpecification.php @@ -16,383 +16,383 @@ class PaymentChargeSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract { /** - * The delivery method(s) to which the delivery charge or payment charge - * specification applies. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param DeliveryMethod|DeliveryMethod[] $appliesToDeliveryMethod + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/appliesToDeliveryMethod + * @see http://schema.org/additionalType */ - public function appliesToDeliveryMethod($appliesToDeliveryMethod) + public function additionalType($additionalType) { - return $this->setProperty('appliesToDeliveryMethod', $appliesToDeliveryMethod); + return $this->setProperty('additionalType', $additionalType); } /** - * The payment method(s) to which the payment charge specification applies. + * An alias for the item. * - * @param PaymentMethod|PaymentMethod[] $appliesToPaymentMethod + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/appliesToPaymentMethod + * @see http://schema.org/alternateName */ - public function appliesToPaymentMethod($appliesToPaymentMethod) + public function alternateName($alternateName) { - return $this->setProperty('appliesToPaymentMethod', $appliesToPaymentMethod); + return $this->setProperty('alternateName', $alternateName); } /** - * The interval and unit of measurement of ordering quantities for which the - * offer or price specification is valid. This allows e.g. specifying that a - * certain freight charge is valid only for a certain quantity. + * The delivery method(s) to which the delivery charge or payment charge + * specification applies. * - * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity + * @param DeliveryMethod|DeliveryMethod[] $appliesToDeliveryMethod * * @return static * - * @see http://schema.org/eligibleQuantity + * @see http://schema.org/appliesToDeliveryMethod */ - public function eligibleQuantity($eligibleQuantity) + public function appliesToDeliveryMethod($appliesToDeliveryMethod) { - return $this->setProperty('eligibleQuantity', $eligibleQuantity); + return $this->setProperty('appliesToDeliveryMethod', $appliesToDeliveryMethod); } /** - * The transaction volume, in a monetary unit, for which the offer or price - * specification is valid, e.g. for indicating a minimal purchasing volume, - * to express free shipping above a certain order volume, or to limit the - * acceptance of credit cards to purchases to a certain minimal amount. + * The payment method(s) to which the payment charge specification applies. * - * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * @param PaymentMethod|PaymentMethod[] $appliesToPaymentMethod * * @return static * - * @see http://schema.org/eligibleTransactionVolume + * @see http://schema.org/appliesToPaymentMethod */ - public function eligibleTransactionVolume($eligibleTransactionVolume) + public function appliesToPaymentMethod($appliesToPaymentMethod) { - return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + return $this->setProperty('appliesToPaymentMethod', $appliesToPaymentMethod); } /** - * The highest price if the price is a range. + * A description of the item. * - * @param float|float[]|int|int[] $maxPrice + * @param string|string[] $description * * @return static * - * @see http://schema.org/maxPrice + * @see http://schema.org/description */ - public function maxPrice($maxPrice) + public function description($description) { - return $this->setProperty('maxPrice', $maxPrice); + return $this->setProperty('description', $description); } /** - * The lowest price if the price is a range. + * 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. * - * @param float|float[]|int|int[] $minPrice + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/minPrice + * @see http://schema.org/disambiguatingDescription */ - public function minPrice($minPrice) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('minPrice', $minPrice); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * The interval and unit of measurement of ordering quantities for which the + * offer or price specification is valid. This allows e.g. specifying that a + * certain freight charge is valid only for a certain quantity. * - * @param float|float[]|int|int[]|string|string[] $price + * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity * * @return static * - * @see http://schema.org/price + * @see http://schema.org/eligibleQuantity */ - public function price($price) + public function eligibleQuantity($eligibleQuantity) { - return $this->setProperty('price', $price); + return $this->setProperty('eligibleQuantity', $eligibleQuantity); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. * - * @param string|string[] $priceCurrency + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/eligibleTransactionVolume */ - public function priceCurrency($priceCurrency) + public function eligibleTransactionVolume($eligibleTransactionVolume) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); } /** - * The date when the item becomes valid. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/validFrom + * @see http://schema.org/identifier */ - public function validFrom($validFrom) + public function identifier($identifier) { - return $this->setProperty('validFrom', $validFrom); + return $this->setProperty('identifier', $identifier); } /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/validThrough + * @see http://schema.org/image */ - public function validThrough($validThrough) + public function image($image) { - return $this->setProperty('validThrough', $validThrough); + return $this->setProperty('image', $image); } /** - * Specifies whether the applicable value-added tax (VAT) is included in the - * price specification or not. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param bool|bool[] $valueAddedTaxIncluded + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/valueAddedTaxIncluded + * @see http://schema.org/mainEntityOfPage */ - public function valueAddedTaxIncluded($valueAddedTaxIncluded) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The highest price if the price is a range. * - * @param string|string[] $additionalType + * @param float|float[]|int|int[] $maxPrice * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/maxPrice */ - public function additionalType($additionalType) + public function maxPrice($maxPrice) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('maxPrice', $maxPrice); } /** - * An alias for the item. + * The lowest price if the price is a range. * - * @param string|string[] $alternateName + * @param float|float[]|int|int[] $minPrice * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/minPrice */ - public function alternateName($alternateName) + public function minPrice($minPrice) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('minPrice', $minPrice); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/price */ - public function identifier($identifier) + public function price($price) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('price', $price); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceCurrency */ - public function image($image) + public function priceCurrency($priceCurrency) { - return $this->setProperty('image', $image); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The date when the item becomes valid. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validFrom */ - public function sameAs($sameAs) + public function validFrom($validFrom) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validFrom', $validFrom); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. * - * @param string|string[] $url + * @param bool|bool[] $valueAddedTaxIncluded * * @return static * - * @see http://schema.org/url + * @see http://schema.org/valueAddedTaxIncluded */ - public function url($url) + public function valueAddedTaxIncluded($valueAddedTaxIncluded) { - return $this->setProperty('url', $url); + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); } } diff --git a/src/PaymentService.php b/src/PaymentService.php index 323f5b657..130d54bf7 100644 --- a/src/PaymentService.php +++ b/src/PaymentService.php @@ -17,65 +17,68 @@ class PaymentService extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract { /** - * The annual rate that is charged for borrowing (or made by investing), - * expressed as a single percentage number that represents the actual yearly - * cost of funds over the term of a loan. This includes any fees or - * additional costs associated with the transaction. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/annualPercentageRate + * @see http://schema.org/additionalType */ - public function annualPercentageRate($annualPercentageRate) + public function additionalType($additionalType) { - return $this->setProperty('annualPercentageRate', $annualPercentageRate); + return $this->setProperty('additionalType', $additionalType); } /** - * Description of fees, commissions, and other terms applied either to a - * class of financial product, or by a financial service organization. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $feesAndCommissionsSpecification + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/feesAndCommissionsSpecification + * @see http://schema.org/aggregateRating */ - public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) + public function aggregateRating($aggregateRating) { - return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The interest rate, charged or paid, applicable to the financial product. - * Note: This is different from the calculated annualPercentageRate. + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/interestRate + * @see http://schema.org/alternateName */ - public function interestRate($interestRate) + public function alternateName($alternateName) { - return $this->setProperty('interestRate', $interestRate); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The annual rate that is charged for borrowing (or made by investing), + * expressed as a single percentage number that represents the actual yearly + * cost of funds over the term of a loan. This includes any fees or + * additional costs associated with the transaction. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $annualPercentageRate * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/annualPercentageRate */ - public function aggregateRating($aggregateRating) + public function annualPercentageRate($annualPercentageRate) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('annualPercentageRate', $annualPercentageRate); } /** @@ -183,380 +186,377 @@ public function category($category) } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * A description of the item. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param string|string[] $description * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/description */ - public function hasOfferCatalog($hasOfferCatalog) + public function description($description) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('description', $description); } /** - * The hours during which this service or contact is available. + * 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. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/hoursAvailable + * @see http://schema.org/disambiguatingDescription */ - public function hoursAvailable($hoursAvailable) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('hoursAvailable', $hoursAvailable); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A pointer to another, somehow related product (or multiple products). + * Description of fees, commissions, and other terms applied either to a + * class of financial product, or by a financial service organization. * - * @param Product|Product[]|Service|Service[] $isRelatedTo + * @param string|string[] $feesAndCommissionsSpecification * * @return static * - * @see http://schema.org/isRelatedTo + * @see http://schema.org/feesAndCommissionsSpecification */ - public function isRelatedTo($isRelatedTo) + public function feesAndCommissionsSpecification($feesAndCommissionsSpecification) { - return $this->setProperty('isRelatedTo', $isRelatedTo); + return $this->setProperty('feesAndCommissionsSpecification', $feesAndCommissionsSpecification); } /** - * A pointer to another, functionally similar product (or multiple - * products). + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param Product|Product[]|Service|Service[] $isSimilarTo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/isSimilarTo + * @see http://schema.org/hasOfferCatalog */ - public function isSimilarTo($isSimilarTo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('isSimilarTo', $isSimilarTo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * An associated logo. + * The hours during which this service or contact is available. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $hoursAvailable * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hoursAvailable */ - public function logo($logo) + public function hoursAvailable($hoursAvailable) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hoursAvailable', $hoursAvailable); } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $offers + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/identifier */ - public function offers($offers) + public function identifier($identifier) { - return $this->setProperty('offers', $offers); + return $this->setProperty('identifier', $identifier); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $produces + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/produces + * @see http://schema.org/image */ - public function produces($produces) + public function image($image) { - return $this->setProperty('produces', $produces); + return $this->setProperty('image', $image); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The interest rate, charged or paid, applicable to the financial product. + * Note: This is different from the calculated annualPercentageRate. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $interestRate * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/interestRate */ - public function provider($provider) + public function interestRate($interestRate) { - return $this->setProperty('provider', $provider); + return $this->setProperty('interestRate', $interestRate); } /** - * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). + * A pointer to another, somehow related product (or multiple products). * - * @param string|string[] $providerMobility + * @param Product|Product[]|Service|Service[] $isRelatedTo * * @return static * - * @see http://schema.org/providerMobility + * @see http://schema.org/isRelatedTo */ - public function providerMobility($providerMobility) + public function isRelatedTo($isRelatedTo) { - return $this->setProperty('providerMobility', $providerMobility); + return $this->setProperty('isRelatedTo', $isRelatedTo); } /** - * A review of the item. + * A pointer to another, functionally similar product (or multiple + * products). * - * @param Review|Review[] $review + * @param Product|Product[]|Service|Service[] $isSimilarTo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/isSimilarTo */ - public function review($review) + public function isSimilarTo($isSimilarTo) { - return $this->setProperty('review', $review); + return $this->setProperty('isSimilarTo', $isSimilarTo); } /** - * The geographic area where the service is provided. + * An associated logo. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/logo */ - public function serviceArea($serviceArea) + public function logo($logo) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('logo', $logo); } /** - * The audience eligible for this service. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Audience|Audience[] $serviceAudience + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceAudience + * @see http://schema.org/mainEntityOfPage */ - public function serviceAudience($serviceAudience) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceAudience', $serviceAudience); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The tangible thing generated by the service, e.g. a passport, permit, - * etc. + * The name of the item. * - * @param Thing|Thing[] $serviceOutput + * @param string|string[] $name * * @return static * - * @see http://schema.org/serviceOutput + * @see http://schema.org/name */ - public function serviceOutput($serviceOutput) + public function name($name) { - return $this->setProperty('serviceOutput', $serviceOutput); + return $this->setProperty('name', $name); } /** - * The type of service being offered, e.g. veterans' benefits, emergency - * relief, etc. + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * - * @param string|string[] $serviceType + * @param Offer|Offer[] $offers * * @return static * - * @see http://schema.org/serviceType + * @see http://schema.org/offers */ - public function serviceType($serviceType) + public function offers($offers) { - return $this->setProperty('serviceType', $serviceType); + return $this->setProperty('offers', $offers); } /** - * A slogan or motto associated with the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $slogan + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/potentialAction */ - public function slogan($slogan) + public function potentialAction($potentialAction) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $produces * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/produces */ - public function additionalType($additionalType) + public function produces($produces) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('produces', $produces); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). * - * @param string|string[] $description + * @param string|string[] $providerMobility * * @return static * - * @see http://schema.org/description + * @see http://schema.org/providerMobility */ - public function description($description) + public function providerMobility($providerMobility) { - return $this->setProperty('description', $description); + return $this->setProperty('providerMobility', $providerMobility); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The geographic area where the service is provided. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceArea */ - public function image($image) + public function serviceArea($serviceArea) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The audience eligible for this service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[] $serviceAudience * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/serviceAudience */ - public function mainEntityOfPage($mainEntityOfPage) + public function serviceAudience($serviceAudience) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('serviceAudience', $serviceAudience); } /** - * The name of the item. + * The tangible thing generated by the service, e.g. a passport, permit, + * etc. * - * @param string|string[] $name + * @param Thing|Thing[] $serviceOutput * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceOutput */ - public function name($name) + public function serviceOutput($serviceOutput) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceOutput', $serviceOutput); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of service being offered, e.g. veterans' benefits, emergency + * relief, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $serviceType * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceType */ - public function potentialAction($potentialAction) + public function serviceType($serviceType) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceType', $serviceType); } /** - * 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. + * A slogan or motto associated with the item. * - * @param string|string[] $sameAs + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/slogan */ - public function sameAs($sameAs) + public function slogan($slogan) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('slogan', $slogan); } /** diff --git a/src/PeopleAudience.php b/src/PeopleAudience.php index 82ac88082..3b9b45604 100644 --- a/src/PeopleAudience.php +++ b/src/PeopleAudience.php @@ -15,119 +15,6 @@ */ class PeopleAudience extends BaseType implements AudienceContract, IntangibleContract, ThingContract { - /** - * Audiences defined by a person's gender. - * - * @param string|string[] $requiredGender - * - * @return static - * - * @see http://schema.org/requiredGender - */ - public function requiredGender($requiredGender) - { - return $this->setProperty('requiredGender', $requiredGender); - } - - /** - * Audiences defined by a person's maximum age. - * - * @param int|int[] $requiredMaxAge - * - * @return static - * - * @see http://schema.org/requiredMaxAge - */ - public function requiredMaxAge($requiredMaxAge) - { - return $this->setProperty('requiredMaxAge', $requiredMaxAge); - } - - /** - * Audiences defined by a person's minimum age. - * - * @param int|int[] $requiredMinAge - * - * @return static - * - * @see http://schema.org/requiredMinAge - */ - public function requiredMinAge($requiredMinAge) - { - return $this->setProperty('requiredMinAge', $requiredMinAge); - } - - /** - * The gender of the person or audience. - * - * @param string|string[] $suggestedGender - * - * @return static - * - * @see http://schema.org/suggestedGender - */ - public function suggestedGender($suggestedGender) - { - return $this->setProperty('suggestedGender', $suggestedGender); - } - - /** - * Maximal age recommended for viewing content. - * - * @param float|float[]|int|int[] $suggestedMaxAge - * - * @return static - * - * @see http://schema.org/suggestedMaxAge - */ - public function suggestedMaxAge($suggestedMaxAge) - { - return $this->setProperty('suggestedMaxAge', $suggestedMaxAge); - } - - /** - * Minimal age recommended for viewing content. - * - * @param float|float[]|int|int[] $suggestedMinAge - * - * @return static - * - * @see http://schema.org/suggestedMinAge - */ - public function suggestedMinAge($suggestedMinAge) - { - return $this->setProperty('suggestedMinAge', $suggestedMinAge); - } - - /** - * The target group associated with a given audience (e.g. veterans, car - * owners, musicians, etc.). - * - * @param string|string[] $audienceType - * - * @return static - * - * @see http://schema.org/audienceType - */ - public function audienceType($audienceType) - { - return $this->setProperty('audienceType', $audienceType); - } - - /** - * The geographic area associated with the audience. - * - * @param AdministrativeArea|AdministrativeArea[] $geographicArea - * - * @return static - * - * @see http://schema.org/geographicArea - */ - public function geographicArea($geographicArea) - { - return $this->setProperty('geographicArea', $geographicArea); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -161,6 +48,21 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The target group associated with a given audience (e.g. veterans, car + * owners, musicians, etc.). + * + * @param string|string[] $audienceType + * + * @return static + * + * @see http://schema.org/audienceType + */ + public function audienceType($audienceType) + { + return $this->setProperty('audienceType', $audienceType); + } + /** * A description of the item. * @@ -192,6 +94,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The geographic area associated with the audience. + * + * @param AdministrativeArea|AdministrativeArea[] $geographicArea + * + * @return static + * + * @see http://schema.org/geographicArea + */ + public function geographicArea($geographicArea) + { + return $this->setProperty('geographicArea', $geographicArea); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -270,6 +186,48 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * Audiences defined by a person's gender. + * + * @param string|string[] $requiredGender + * + * @return static + * + * @see http://schema.org/requiredGender + */ + public function requiredGender($requiredGender) + { + return $this->setProperty('requiredGender', $requiredGender); + } + + /** + * Audiences defined by a person's maximum age. + * + * @param int|int[] $requiredMaxAge + * + * @return static + * + * @see http://schema.org/requiredMaxAge + */ + public function requiredMaxAge($requiredMaxAge) + { + return $this->setProperty('requiredMaxAge', $requiredMaxAge); + } + + /** + * Audiences defined by a person's minimum age. + * + * @param int|int[] $requiredMinAge + * + * @return static + * + * @see http://schema.org/requiredMinAge + */ + public function requiredMinAge($requiredMinAge) + { + return $this->setProperty('requiredMinAge', $requiredMinAge); + } + /** * 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 @@ -300,6 +258,48 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The gender of the person or audience. + * + * @param string|string[] $suggestedGender + * + * @return static + * + * @see http://schema.org/suggestedGender + */ + public function suggestedGender($suggestedGender) + { + return $this->setProperty('suggestedGender', $suggestedGender); + } + + /** + * Maximal age recommended for viewing content. + * + * @param float|float[]|int|int[] $suggestedMaxAge + * + * @return static + * + * @see http://schema.org/suggestedMaxAge + */ + public function suggestedMaxAge($suggestedMaxAge) + { + return $this->setProperty('suggestedMaxAge', $suggestedMaxAge); + } + + /** + * Minimal age recommended for viewing content. + * + * @param float|float[]|int|int[] $suggestedMinAge + * + * @return static + * + * @see http://schema.org/suggestedMinAge + */ + public function suggestedMinAge($suggestedMinAge) + { + return $this->setProperty('suggestedMinAge', $suggestedMinAge); + } + /** * URL of the item. * diff --git a/src/PerformAction.php b/src/PerformAction.php index f232979c0..31d5e12c8 100644 --- a/src/PerformAction.php +++ b/src/PerformAction.php @@ -15,61 +15,36 @@ class PerformAction extends BaseType implements PlayActionContract, ActionContract, ThingContract { /** - * A sub property of location. The entertainment business where the action - * occurred. - * - * @param EntertainmentBusiness|EntertainmentBusiness[] $entertainmentBusiness - * - * @return static - * - * @see http://schema.org/entertainmentBusiness - */ - public function entertainmentBusiness($entertainmentBusiness) - { - return $this->setProperty('entertainmentBusiness', $entertainmentBusiness); - } - - /** - * An intended audience, i.e. a group for whom something was created. - * - * @param Audience|Audience[] $audience - * - * @return static - * - * @see http://schema.org/audience - */ - public function audience($audience) - { - return $this->setProperty('audience', $audience); - } - - /** - * Upcoming or past event associated with this place, organization, or - * action. + * Indicates the current disposition of the Action. * - * @param Event|Event[] $event + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/event + * @see http://schema.org/actionStatus */ - public function event($event) + public function actionStatus($actionStatus) { - return $this->setProperty('event', $event); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -88,295 +63,283 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * An intended audience, i.e. a group for whom something was created. * - * @param Thing|Thing[] $error + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/error + * @see http://schema.org/audience */ - public function error($error) + public function audience($audience) { - return $this->setProperty('error', $error); + return $this->setProperty('audience', $audience); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * A sub property of location. The entertainment business where the action + * occurred. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param EntertainmentBusiness|EntertainmentBusiness[] $entertainmentBusiness * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/entertainmentBusiness */ - public function participant($participant) + public function entertainmentBusiness($entertainmentBusiness) { - return $this->setProperty('participant', $participant); + return $this->setProperty('entertainmentBusiness', $entertainmentBusiness); } /** - * The result produced in the action. e.g. John wrote *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/result + * @see http://schema.org/error */ - public function result($result) + public function error($error) { - return $this->setProperty('result', $result); + return $this->setProperty('error', $error); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/event */ - public function startTime($startTime) + public function event($event) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('event', $event); } /** - * Indicates a target EntryPoint for an Action. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param EntryPoint|EntryPoint[] $target + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/target + * @see http://schema.org/identifier */ - public function target($target) + public function identifier($identifier) { - return $this->setProperty('target', $target); + return $this->setProperty('identifier', $identifier); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/image */ - public function additionalType($additionalType) + public function image($image) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('image', $image); } /** - * An alias for the item. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/instrument */ - public function alternateName($alternateName) + public function instrument($instrument) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('instrument', $instrument); } /** - * A description of the item. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $description + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/description + * @see http://schema.org/location */ - public function description($description) + public function location($location) { - return $this->setProperty('description', $description); + return $this->setProperty('location', $location); } /** - * 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. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $disambiguatingDescription + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/mainEntityOfPage */ - public function disambiguatingDescription($disambiguatingDescription) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The name of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $name * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/name */ - public function identifier($identifier) + public function name($name) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('name', $name); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/image + * @see http://schema.org/object */ - public function image($image) + public function object($object) { - return $this->setProperty('image', $image); + return $this->setProperty('object', $object); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/participant */ - public function mainEntityOfPage($mainEntityOfPage) + public function participant($participant) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('participant', $participant); } /** - * The name of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $name + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/name + * @see http://schema.org/potentialAction */ - public function name($name) + public function potentialAction($potentialAction) { - return $this->setProperty('name', $name); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The result produced in the action. e.g. John wrote *a book*. * - * @param Action|Action[] $potentialAction + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/result */ - public function potentialAction($potentialAction) + public function result($result) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('result', $result); } /** @@ -395,6 +358,29 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * + * @return static + * + * @see http://schema.org/startTime + */ + public function startTime($startTime) + { + return $this->setProperty('startTime', $startTime); + } + /** * A CreativeWork or Event about this Thing. * @@ -409,6 +395,20 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + /** * URL of the item. * diff --git a/src/PerformanceRole.php b/src/PerformanceRole.php index 7102fd6aa..675b4e983 100644 --- a/src/PerformanceRole.php +++ b/src/PerformanceRole.php @@ -15,84 +15,6 @@ */ class PerformanceRole extends BaseType implements RoleContract, IntangibleContract, ThingContract { - /** - * The name of a character played in some acting or performing role, i.e. in - * a PerformanceRole. - * - * @param string|string[] $characterName - * - * @return static - * - * @see http://schema.org/characterName - */ - public function characterName($characterName) - { - return $this->setProperty('characterName', $characterName); - } - - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * A position played, performed or filled by a person or organization, as - * part of an organization. For example, an athlete in a SportsTeam might - * play in the position named 'Quarterback'. - * - * @param string|string[] $namedPosition - * - * @return static - * - * @see http://schema.org/namedPosition - */ - public function namedPosition($namedPosition) - { - return $this->setProperty('namedPosition', $namedPosition); - } - - /** - * A role played, performed or filled by a person or organization. For - * example, the team of creators for a comic book might fill the roles named - * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might - * play in the position named 'Quarterback'. - * - * @param string|string[] $roleName - * - * @return static - * - * @see http://schema.org/roleName - */ - public function roleName($roleName) - { - return $this->setProperty('roleName', $roleName); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -126,6 +48,21 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The name of a character played in some acting or performing role, i.e. in + * a PerformanceRole. + * + * @param string|string[] $characterName + * + * @return static + * + * @see http://schema.org/characterName + */ + public function characterName($characterName) + { + return $this->setProperty('characterName', $characterName); + } + /** * A description of the item. * @@ -157,6 +94,21 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -220,6 +172,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A position played, performed or filled by a person or organization, as + * part of an organization. For example, an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $namedPosition + * + * @return static + * + * @see http://schema.org/namedPosition + */ + public function namedPosition($namedPosition) + { + return $this->setProperty('namedPosition', $namedPosition); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -235,6 +203,23 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A role played, performed or filled by a person or organization. For + * example, the team of creators for a comic book might fill the roles named + * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $roleName + * + * @return static + * + * @see http://schema.org/roleName + */ + public function roleName($roleName) + { + return $this->setProperty('roleName', $roleName); + } + /** * 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 @@ -251,6 +236,21 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + /** * A CreativeWork or Event about this Thing. * diff --git a/src/PerformingArtsTheater.php b/src/PerformingArtsTheater.php index 5f9edc21e..6ca981c80 100644 --- a/src/PerformingArtsTheater.php +++ b/src/PerformingArtsTheater.php @@ -14,35 +14,6 @@ */ class PerformingArtsTheater extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/PerformingGroup.php b/src/PerformingGroup.php index 2feb139dd..8035c1f06 100644 --- a/src/PerformingGroup.php +++ b/src/PerformingGroup.php @@ -13,6 +13,25 @@ */ class PerformingGroup extends BaseType implements OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -42,6 +61,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -144,6 +177,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -375,6 +439,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -449,6 +546,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -522,6 +635,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -579,6 +706,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -631,6 +773,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -706,6 +864,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -736,203 +908,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Periodical.php b/src/Periodical.php index 65c28e602..44837d402 100644 --- a/src/Periodical.php +++ b/src/Periodical.php @@ -21,52 +21,6 @@ */ class Periodical extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - /** * The subject matter of the content. * @@ -211,6 +165,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -226,6 +199,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -517,6 +504,53 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -630,6 +664,21 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -742,6 +791,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -864,6 +946,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -939,6 +1037,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -969,6 +1083,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -999,6 +1127,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1140,6 +1283,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1222,6 +1381,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1343,6 +1531,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1386,206 +1588,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - } diff --git a/src/Permit.php b/src/Permit.php index 50ba4c1ba..eeac35558 100644 --- a/src/Permit.php +++ b/src/Permit.php @@ -13,104 +13,6 @@ */ class Permit extends BaseType implements IntangibleContract, ThingContract { - /** - * The organization issuing the ticket or permit. - * - * @param Organization|Organization[] $issuedBy - * - * @return static - * - * @see http://schema.org/issuedBy - */ - public function issuedBy($issuedBy) - { - return $this->setProperty('issuedBy', $issuedBy); - } - - /** - * The service through with the permit was granted. - * - * @param Service|Service[] $issuedThrough - * - * @return static - * - * @see http://schema.org/issuedThrough - */ - public function issuedThrough($issuedThrough) - { - return $this->setProperty('issuedThrough', $issuedThrough); - } - - /** - * The target audience for this permit. - * - * @param Audience|Audience[] $permitAudience - * - * @return static - * - * @see http://schema.org/permitAudience - */ - public function permitAudience($permitAudience) - { - return $this->setProperty('permitAudience', $permitAudience); - } - - /** - * The duration of validity of a permit or similar thing. - * - * @param Duration|Duration[] $validFor - * - * @return static - * - * @see http://schema.org/validFor - */ - public function validFor($validFor) - { - return $this->setProperty('validFor', $validFor); - } - - /** - * The date when the item becomes valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom - * - * @return static - * - * @see http://schema.org/validFrom - */ - public function validFrom($validFrom) - { - return $this->setProperty('validFrom', $validFrom); - } - - /** - * The geographic area where a permit or similar thing is valid. - * - * @param AdministrativeArea|AdministrativeArea[] $validIn - * - * @return static - * - * @see http://schema.org/validIn - */ - public function validIn($validIn) - { - return $this->setProperty('validIn', $validIn); - } - - /** - * The date when the item is no longer valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validUntil - * - * @return static - * - * @see http://schema.org/validUntil - */ - public function validUntil($validUntil) - { - return $this->setProperty('validUntil', $validUntil); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -208,6 +110,34 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The organization issuing the ticket or permit. + * + * @param Organization|Organization[] $issuedBy + * + * @return static + * + * @see http://schema.org/issuedBy + */ + public function issuedBy($issuedBy) + { + return $this->setProperty('issuedBy', $issuedBy); + } + + /** + * The service through with the permit was granted. + * + * @param Service|Service[] $issuedThrough + * + * @return static + * + * @see http://schema.org/issuedThrough + */ + public function issuedThrough($issuedThrough) + { + return $this->setProperty('issuedThrough', $issuedThrough); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -238,6 +168,20 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The target audience for this permit. + * + * @param Audience|Audience[] $permitAudience + * + * @return static + * + * @see http://schema.org/permitAudience + */ + public function permitAudience($permitAudience) + { + return $this->setProperty('permitAudience', $permitAudience); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -297,4 +241,60 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The duration of validity of a permit or similar thing. + * + * @param Duration|Duration[] $validFor + * + * @return static + * + * @see http://schema.org/validFor + */ + public function validFor($validFor) + { + return $this->setProperty('validFor', $validFor); + } + + /** + * The date when the item becomes valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * + * @return static + * + * @see http://schema.org/validFrom + */ + public function validFrom($validFrom) + { + return $this->setProperty('validFrom', $validFrom); + } + + /** + * The geographic area where a permit or similar thing is valid. + * + * @param AdministrativeArea|AdministrativeArea[] $validIn + * + * @return static + * + * @see http://schema.org/validIn + */ + public function validIn($validIn) + { + return $this->setProperty('validIn', $validIn); + } + + /** + * The date when the item is no longer valid. + * + * @param \DateTimeInterface|\DateTimeInterface[] $validUntil + * + * @return static + * + * @see http://schema.org/validUntil + */ + public function validUntil($validUntil) + { + return $this->setProperty('validUntil', $validUntil); + } + } diff --git a/src/Person.php b/src/Person.php index 7b7231772..3aa3150dd 100644 --- a/src/Person.php +++ b/src/Person.php @@ -26,6 +26,25 @@ public function additionalName($additionalName) return $this->setProperty('additionalName', $additionalName); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -55,6 +74,20 @@ public function affiliation($affiliation) return $this->setProperty('affiliation', $affiliation); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An organization that the person is an alumni of. * @@ -238,6 +271,37 @@ public function deathPlace($deathPlace) return $this->setProperty('deathPlace', $deathPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The Dun & Bradstreet DUNS number for identifying an organization or * business person. @@ -473,6 +537,39 @@ public function honorificSuffix($honorificSuffix) return $this->setProperty('honorificSuffix', $honorificSuffix); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -517,6 +614,22 @@ public function knows($knows) return $this->setProperty('knows', $knows); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -561,6 +674,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * Nationality of the person. * @@ -646,6 +773,21 @@ public function performerIn($performerIn) return $this->setProperty('performerIn', $performerIn); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -684,6 +826,22 @@ public function relatedTo($relatedTo) return $this->setProperty('relatedTo', $relatedTo); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -757,6 +915,20 @@ public function spouse($spouse) return $this->setProperty('spouse', $spouse); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -786,6 +958,20 @@ public function telephone($telephone) return $this->setProperty('telephone', $telephone); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The Value-added Tax ID of the organization or person. * @@ -842,190 +1028,4 @@ public function worksFor($worksFor) return $this->setProperty('worksFor', $worksFor); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/PetStore.php b/src/PetStore.php index 900f96376..b1077137d 100644 --- a/src/PetStore.php +++ b/src/PetStore.php @@ -17,126 +17,104 @@ class PetStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Pharmacy.php b/src/Pharmacy.php index 957965205..bc99946f6 100644 --- a/src/Pharmacy.php +++ b/src/Pharmacy.php @@ -14,6 +14,25 @@ */ class Pharmacy extends BaseType implements MedicalOrganizationContract, OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -43,6 +62,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -145,6 +178,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -376,6 +440,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -450,6 +547,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -523,6 +636,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -580,6 +707,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -632,6 +774,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -707,6 +865,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -737,203 +909,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Photograph.php b/src/Photograph.php index 99e6f0828..149579620 100644 --- a/src/Photograph.php +++ b/src/Photograph.php @@ -157,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -172,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -463,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -688,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -885,6 +982,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -915,6 +1028,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -945,6 +1072,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1086,6 +1228,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1168,6 +1326,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1289,6 +1461,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1332,190 +1518,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/PhotographAction.php b/src/PhotographAction.php index c0fcc102e..16d12aa2e 100644 --- a/src/PhotographAction.php +++ b/src/PhotographAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Physician.php b/src/Physician.php index 06c53e54f..ceb9e91ae 100644 --- a/src/Physician.php +++ b/src/Physician.php @@ -14,6 +14,25 @@ */ class Physician extends BaseType implements MedicalOrganizationContract, OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -43,6 +62,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -145,6 +178,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -376,6 +440,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -450,6 +547,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -523,6 +636,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -580,6 +707,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -632,6 +774,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -707,6 +865,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -737,203 +909,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Place.php b/src/Place.php index 1ca29e7f9..128769a66 100644 --- a/src/Place.php +++ b/src/Place.php @@ -34,6 +34,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -63,6 +82,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -143,6 +176,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -231,6 +295,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -305,6 +402,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -347,6 +460,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -389,6 +516,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -432,6 +574,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -479,189 +637,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/PlaceOfWorship.php b/src/PlaceOfWorship.php index c4da23497..40e28c6cb 100644 --- a/src/PlaceOfWorship.php +++ b/src/PlaceOfWorship.php @@ -14,35 +14,6 @@ */ class PlaceOfWorship extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/PlanAction.php b/src/PlanAction.php index c48f1553f..4101932b6 100644 --- a/src/PlanAction.php +++ b/src/PlanAction.php @@ -16,31 +16,36 @@ class PlanAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract { /** - * The time the object is scheduled to. + * Indicates the current disposition of the Action. * - * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/scheduledTime + * @see http://schema.org/actionStatus */ - public function scheduledTime($scheduledTime) + public function actionStatus($actionStatus) { - return $this->setProperty('scheduledTime', $scheduledTime); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -59,325 +64,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The time the object is scheduled to. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/scheduledTime */ - public function name($name) + public function scheduledTime($scheduledTime) { - return $this->setProperty('name', $name); + return $this->setProperty('scheduledTime', $scheduledTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/PlayAction.php b/src/PlayAction.php index 987d3c628..3ab8ad5d0 100644 --- a/src/PlayAction.php +++ b/src/PlayAction.php @@ -24,46 +24,36 @@ class PlayAction extends BaseType implements ActionContract, ThingContract { /** - * An intended audience, i.e. a group for whom something was created. - * - * @param Audience|Audience[] $audience - * - * @return static - * - * @see http://schema.org/audience - */ - public function audience($audience) - { - return $this->setProperty('audience', $audience); - } - - /** - * Upcoming or past event associated with this place, organization, or - * action. + * Indicates the current disposition of the Action. * - * @param Event|Event[] $event + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/event + * @see http://schema.org/actionStatus */ - public function event($event) + public function actionStatus($actionStatus) { - return $this->setProperty('event', $event); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -82,311 +72,307 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * An intended audience, i.e. a group for whom something was created. * - * @param Thing|Thing[] $error + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/error + * @see http://schema.org/audience */ - public function error($error) + public function audience($audience) { - return $this->setProperty('error', $error); + return $this->setProperty('audience', $audience); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param Thing|Thing[] $result + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/result + * @see http://schema.org/event */ - public function result($result) + public function event($event) { - return $this->setProperty('result', $result); + return $this->setProperty('event', $event); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/identifier */ - public function startTime($startTime) + public function identifier($identifier) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('identifier', $identifier); } /** - * Indicates a target EntryPoint for an Action. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param EntryPoint|EntryPoint[] $target + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/target + * @see http://schema.org/image */ - public function target($target) + public function image($image) { - return $this->setProperty('target', $target); + return $this->setProperty('image', $image); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/instrument */ - public function additionalType($additionalType) + public function instrument($instrument) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('instrument', $instrument); } /** - * An alias for the item. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $alternateName + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/location */ - public function alternateName($alternateName) + public function location($location) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('location', $location); } /** - * A description of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $description + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/description + * @see http://schema.org/mainEntityOfPage */ - public function description($description) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('description', $description); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. + * The name of the item. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $name * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/name */ - public function disambiguatingDescription($disambiguatingDescription) + public function name($name) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('name', $name); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/object */ - public function identifier($identifier) + public function object($object) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('object', $object); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/image + * @see http://schema.org/participant */ - public function image($image) + public function participant($participant) { - return $this->setProperty('image', $image); + return $this->setProperty('participant', $participant); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/potentialAction */ - public function mainEntityOfPage($mainEntityOfPage) + public function potentialAction($potentialAction) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The name of the item. + * The result produced in the action. e.g. John wrote *a book*. * - * @param string|string[] $name + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/name + * @see http://schema.org/result */ - public function name($name) + public function result($result) { - return $this->setProperty('name', $name); + return $this->setProperty('result', $result); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * 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. * - * @param Action|Action[] $potentialAction + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/sameAs */ - public function potentialAction($potentialAction) + public function sameAs($sameAs) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('sameAs', $sameAs); } /** - * 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. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/startTime */ - public function sameAs($sameAs) + public function startTime($startTime) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('startTime', $startTime); } /** @@ -403,6 +389,20 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + /** * URL of the item. * diff --git a/src/Playground.php b/src/Playground.php index 1c76d9684..9be22190e 100644 --- a/src/Playground.php +++ b/src/Playground.php @@ -14,35 +14,6 @@ */ class Playground extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Plumber.php b/src/Plumber.php index 7eaf3aa81..11e0f990f 100644 --- a/src/Plumber.php +++ b/src/Plumber.php @@ -17,126 +17,104 @@ class Plumber extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/PoliceStation.php b/src/PoliceStation.php index 147d1938c..6065b85e7 100644 --- a/src/PoliceStation.php +++ b/src/PoliceStation.php @@ -17,35 +17,6 @@ */ class PoliceStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -68,6 +39,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -97,6 +87,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -115,479 +119,495 @@ public function amenityFeature($amenityFeature) } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The geographic area where a service or offered item is provided. * - * @param string|string[] $branchCode + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/areaServed */ - public function branchCode($branchCode) + public function areaServed($areaServed) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('areaServed', $areaServed); } /** - * The basic containment relation between a place and one that contains it. + * An award won by or for this item. * - * @param Place|Place[] $containedIn + * @param string|string[] $award * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/award */ - public function containedIn($containedIn) + public function award($award) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('award', $award); } /** - * The basic containment relation between a place and one that contains it. + * Awards won by or for this item. * - * @param Place|Place[] $containedInPlace + * @param string|string[] $awards * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/awards */ - public function containedInPlace($containedInPlace) + public function awards($awards) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('awards', $awards); } /** - * The basic containment relation between a place and another that it - * contains. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/branchCode */ - public function containsPlace($containsPlace) + public function branchCode($branchCode) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('branchCode', $branchCode); } /** - * Upcoming or past event associated with this place, organization, or - * action. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param Event|Event[] $event + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/event + * @see http://schema.org/branchOf */ - public function event($event) + public function branchOf($branchOf) { - return $this->setProperty('event', $event); + return $this->setProperty('branchOf', $branchOf); } /** - * Upcoming or past events associated with this place or organization. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param Event|Event[] $events + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/events + * @see http://schema.org/brand */ - public function events($events) + public function brand($brand) { - return $this->setProperty('events', $events); + return $this->setProperty('brand', $brand); } /** - * The fax number. + * A contact point for a person or organization. * - * @param string|string[] $faxNumber + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/faxNumber + * @see http://schema.org/contactPoint */ - public function faxNumber($faxNumber) + public function contactPoint($contactPoint) { - return $this->setProperty('faxNumber', $faxNumber); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The geo coordinates of the place. + * A contact point for a person or organization. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/contactPoints */ - public function geo($geo) + public function contactPoints($contactPoints) { - return $this->setProperty('geo', $geo); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $globalLocationNumber + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/containedIn */ - public function globalLocationNumber($globalLocationNumber) + public function containedIn($containedIn) { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); + return $this->setProperty('containedIn', $containedIn); } /** - * A URL to a map of the place. + * The basic containment relation between a place and one that contains it. * - * @param Map|Map[]|string|string[] $hasMap + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/containedInPlace */ - public function hasMap($hasMap) + public function containedInPlace($containedInPlace) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The basic containment relation between a place and another that it + * contains. * - * @param bool|bool[] $isAccessibleForFree + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/containsPlace */ - public function isAccessibleForFree($isAccessibleForFree) + public function containsPlace($containsPlace) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $isicV4 + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/currenciesAccepted */ - public function isicV4($isicV4) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/department */ - public function latitude($latitude) + public function department($department) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('department', $department); } /** - * An associated logo. + * A description of the item. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param string|string[] $description * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/description */ - public function logo($logo) + public function description($description) { - return $this->setProperty('logo', $logo); + return $this->setProperty('description', $description); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * 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. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/disambiguatingDescription */ - public function longitude($longitude) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A URL to a map of the place. + * The date that this organization was dissolved. * - * @param string|string[] $map + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate * * @return static * - * @see http://schema.org/map + * @see http://schema.org/dissolutionDate */ - public function map($map) + public function dissolutionDate($dissolutionDate) { - return $this->setProperty('map', $map); + return $this->setProperty('dissolutionDate', $dissolutionDate); } /** - * A URL to a map of the place. + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. * - * @param string|string[] $maps + * @param string|string[] $duns * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/duns */ - public function maps($maps) + public function duns($duns) { - return $this->setProperty('maps', $maps); + return $this->setProperty('duns', $duns); } /** - * The total number of individuals that may attend an event or venue. + * Email address. * - * @param int|int[] $maximumAttendeeCapacity + * @param string|string[] $email * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/email */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function email($email) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('email', $email); } /** - * The opening hours of a certain place. + * Someone working for this organization. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Person|Person[] $employee * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/employee */ - public function openingHoursSpecification($openingHoursSpecification) + public function employee($employee) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('employee', $employee); } /** - * A photograph of this place. + * People working for this organization. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param Person|Person[] $employees * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/employees */ - public function photo($photo) + public function employees($employees) { - return $this->setProperty('photo', $photo); + return $this->setProperty('employees', $employees); } /** - * Photographs of this place. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/event */ - public function photos($photos) + public function event($event) { - return $this->setProperty('photos', $photos); + return $this->setProperty('event', $event); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * Upcoming or past events associated with this place or organization. * - * @param bool|bool[] $publicAccess + * @param Event|Event[] $events * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/events */ - public function publicAccess($publicAccess) + public function events($events) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('events', $events); } /** - * A review of the item. + * The fax number. * - * @param Review|Review[] $review + * @param string|string[] $faxNumber * * @return static * - * @see http://schema.org/review + * @see http://schema.org/faxNumber */ - public function review($review) + public function faxNumber($faxNumber) { - return $this->setProperty('review', $review); + return $this->setProperty('faxNumber', $faxNumber); } /** - * Review of the item. + * A person who founded this organization. * - * @param Review|Review[] $reviews + * @param Person|Person[] $founder * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/founder */ - public function reviews($reviews) + public function founder($founder) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('founder', $founder); } /** - * A slogan or motto associated with the item. + * A person who founded this organization. * - * @param string|string[] $slogan + * @param Person|Person[] $founders * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/founders */ - public function slogan($slogan) + public function founders($founders) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('founders', $founders); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * The date that this organization was founded. * - * @param bool|bool[] $smokingAllowed + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/foundingDate */ - public function smokingAllowed($smokingAllowed) + public function foundingDate($foundingDate) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('foundingDate', $foundingDate); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The place where the Organization was founded. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param Place|Place[] $foundingLocation * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/foundingLocation */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function foundingLocation($foundingLocation) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('foundingLocation', $foundingLocation); } /** - * The telephone number. + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $funder * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/funder */ - public function telephone($telephone) + public function funder($funder) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('funder', $funder); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geo coordinates of the place. * - * @param string|string[] $additionalType + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/geo */ - public function additionalType($additionalType) + public function geo($geo) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('geo', $geo); } /** - * An alias for the item. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $alternateName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/globalLocationNumber */ - public function alternateName($alternateName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * A description of the item. + * A URL to a map of the place. * - * @param string|string[] $description + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/description + * @see http://schema.org/hasMap */ - public function description($description) + public function hasMap($hasMap) { - return $this->setProperty('description', $description); + return $this->setProperty('hasMap', $hasMap); } /** - * 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. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param string|string[] $disambiguatingDescription + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/hasOfferCatalog */ - public function disambiguatingDescription($disambiguatingDescription) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); } /** @@ -624,657 +644,595 @@ public function image($image) } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A flag to signal that the item, event, or place is accessible for free. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/isAccessibleForFree */ - public function mainEntityOfPage($mainEntityOfPage) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The name of the item. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $name + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/name + * @see http://schema.org/isicV4 */ - public function name($name) + public function isicV4($isicV4) { - return $this->setProperty('name', $name); + return $this->setProperty('isicV4', $isicV4); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/latitude */ - public function potentialAction($potentialAction) + public function latitude($latitude) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('latitude', $latitude); } /** - * 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. + * The official name of the organization, e.g. the registered company name. * - * @param string|string[] $sameAs + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/legalName */ - public function sameAs($sameAs) + public function legalName($legalName) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('legalName', $legalName); } /** - * A CreativeWork or Event about this Thing. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/leiCode */ - public function subjectOf($subjectOf) + public function leiCode($leiCode) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $currenciesAccepted - * - * @return static - * - * @see http://schema.org/currenciesAccepted - */ - public function currenciesAccepted($currenciesAccepted) - { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); - } - - /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. - * - * @param string|string[] $paymentAccepted - * - * @return static - * - * @see http://schema.org/paymentAccepted - */ - public function paymentAccepted($paymentAccepted) - { - return $this->setProperty('paymentAccepted', $paymentAccepted); - } - - /** - * The price range of the business, for example ```$$$```. - * - * @param string|string[] $priceRange - * - * @return static - * - * @see http://schema.org/priceRange - */ - public function priceRange($priceRange) - { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('leiCode', $leiCode); } /** - * The geographic area where a service or offered item is provided. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/location */ - public function areaServed($areaServed) + public function location($location) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('location', $location); } /** - * An award won by or for this item. + * An associated logo. * - * @param string|string[] $award + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/award + * @see http://schema.org/logo */ - public function award($award) + public function logo($logo) { - return $this->setProperty('award', $award); + return $this->setProperty('logo', $logo); } /** - * Awards won by or for this item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $awards + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/longitude */ - public function awards($awards) + public function longitude($longitude) { - return $this->setProperty('awards', $awards); + return $this->setProperty('longitude', $longitude); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/mainEntityOfPage */ - public function brand($brand) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('brand', $brand); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A contact point for a person or organization. + * A pointer to products or services offered by the organization or person. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/makesOffer */ - public function contactPoint($contactPoint) + public function makesOffer($makesOffer) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A contact point for a person or organization. + * A URL to a map of the place. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $map * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/map */ - public function contactPoints($contactPoints) + public function map($map) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('map', $map); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * A URL to a map of the place. * - * @param Organization|Organization[] $department + * @param string|string[] $maps * * @return static * - * @see http://schema.org/department + * @see http://schema.org/maps */ - public function department($department) + public function maps($maps) { - return $this->setProperty('department', $department); + return $this->setProperty('maps', $maps); } /** - * The date that this organization was dissolved. + * The total number of individuals that may attend an event or venue. * - * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/dissolutionDate + * @see http://schema.org/maximumAttendeeCapacity */ - public function dissolutionDate($dissolutionDate) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('dissolutionDate', $dissolutionDate); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * The Dun & Bradstreet DUNS number for identifying an organization or - * business person. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param string|string[] $duns + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/duns + * @see http://schema.org/member */ - public function duns($duns) + public function member($member) { - return $this->setProperty('duns', $duns); + return $this->setProperty('member', $member); } /** - * Email address. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $email + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/email + * @see http://schema.org/memberOf */ - public function email($email) + public function memberOf($memberOf) { - return $this->setProperty('email', $email); + return $this->setProperty('memberOf', $memberOf); } /** - * Someone working for this organization. + * A member of this organization. * - * @param Person|Person[] $employee + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/employee + * @see http://schema.org/members */ - public function employee($employee) + public function members($members) { - return $this->setProperty('employee', $employee); + return $this->setProperty('members', $members); } /** - * People working for this organization. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param Person|Person[] $employees + * @param string|string[] $naics * * @return static * - * @see http://schema.org/employees + * @see http://schema.org/naics */ - public function employees($employees) + public function naics($naics) { - return $this->setProperty('employees', $employees); + return $this->setProperty('naics', $naics); } /** - * A person who founded this organization. + * The name of the item. * - * @param Person|Person[] $founder + * @param string|string[] $name * * @return static * - * @see http://schema.org/founder + * @see http://schema.org/name */ - public function founder($founder) + public function name($name) { - return $this->setProperty('founder', $founder); + return $this->setProperty('name', $name); } /** - * A person who founded this organization. + * The number of employees in an organization e.g. business. * - * @param Person|Person[] $founders + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/founders + * @see http://schema.org/numberOfEmployees */ - public function founders($founders) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('founders', $founders); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * The date that this organization was founded. + * A pointer to the organization or person making the offer. * - * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/foundingDate + * @see http://schema.org/offeredBy */ - public function foundingDate($foundingDate) + public function offeredBy($offeredBy) { - return $this->setProperty('foundingDate', $foundingDate); + return $this->setProperty('offeredBy', $offeredBy); } /** - * The place where the Organization was founded. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param Place|Place[] $foundingLocation + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/foundingLocation + * @see http://schema.org/openingHours */ - public function foundingLocation($foundingLocation) + public function openingHours($openingHours) { - return $this->setProperty('foundingLocation', $foundingLocation); + return $this->setProperty('openingHours', $openingHours); } /** - * A person or organization that supports (sponsors) something through some - * kind of financial contribution. + * The opening hours of a certain place. * - * @param Organization|Organization[]|Person|Person[] $funder + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/funder + * @see http://schema.org/openingHoursSpecification */ - public function funder($funder) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('funder', $funder); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * Products owned by the organization or person. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/owns */ - public function hasOfferCatalog($hasOfferCatalog) + public function owns($owns) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('owns', $owns); } /** - * Points-of-Sales operated by the organization or person. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param Place|Place[] $hasPOS + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/hasPOS + * @see http://schema.org/parentOrganization */ - public function hasPOS($hasPOS) + public function parentOrganization($parentOrganization) { - return $this->setProperty('hasPOS', $hasPOS); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The official name of the organization, e.g. the registered company name. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $legalName + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/paymentAccepted */ - public function legalName($legalName) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A photograph of this place. * - * @param string|string[] $leiCode + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/photo */ - public function leiCode($leiCode) + public function photo($photo) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('photo', $photo); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Photographs of this place. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/location + * @see http://schema.org/photos */ - public function location($location) + public function photos($photos) { - return $this->setProperty('location', $location); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services offered by the organization or person. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Offer|Offer[] $makesOffer + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/potentialAction */ - public function makesOffer($makesOffer) + public function potentialAction($potentialAction) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * The price range of the business, for example ```$$$```. * - * @param Organization|Organization[]|Person|Person[] $member + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/member + * @see http://schema.org/priceRange */ - public function member($member) + public function priceRange($priceRange) { - return $this->setProperty('member', $member); + return $this->setProperty('priceRange', $priceRange); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/publicAccess */ - public function memberOf($memberOf) + public function publicAccess($publicAccess) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A member of this organization. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $members + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/members + * @see http://schema.org/publishingPrinciples */ - public function members($members) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('members', $members); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * A review of the item. * - * @param string|string[] $naics + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/review */ - public function naics($naics) + public function review($review) { - return $this->setProperty('naics', $naics); + return $this->setProperty('review', $review); } /** - * The number of employees in an organization e.g. business. + * Review of the item. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/reviews */ - public function numberOfEmployees($numberOfEmployees) + public function reviews($reviews) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('reviews', $reviews); } /** - * A pointer to the organization or person making the offer. + * 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. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/sameAs */ - public function offeredBy($offeredBy) + public function sameAs($sameAs) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('sameAs', $sameAs); } /** - * Products owned by the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/seeks */ - public function owns($owns) + public function seeks($seeks) { - return $this->setProperty('owns', $owns); + return $this->setProperty('seeks', $seeks); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The geographic area where the service is provided. * - * @param Organization|Organization[] $parentOrganization + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/serviceArea */ - public function parentOrganization($parentOrganization) + public function serviceArea($serviceArea) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('serviceArea', $serviceArea); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/slogan */ - public function publishingPrinciples($publishingPrinciples) + public function slogan($slogan) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('slogan', $slogan); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param Demand|Demand[] $seeks + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/smokingAllowed */ - public function seeks($seeks) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * The geographic area where the service is provided. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/specialOpeningHoursSpecification */ - public function serviceArea($serviceArea) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** @@ -1309,6 +1267,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -1324,6 +1296,34 @@ public function taxID($taxID) return $this->setProperty('taxID', $taxID); } + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The Value-added Tax ID of the organization or person. * diff --git a/src/Pond.php b/src/Pond.php index 6d952a913..542b01c6c 100644 --- a/src/Pond.php +++ b/src/Pond.php @@ -37,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -66,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -146,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -234,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -308,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -350,6 +463,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -392,6 +519,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -435,6 +577,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -482,189 +640,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/PostOffice.php b/src/PostOffice.php index 7c11c29a2..b0592c7c7 100644 --- a/src/PostOffice.php +++ b/src/PostOffice.php @@ -17,126 +17,104 @@ class PostOffice extends BaseType implements GovernmentOfficeContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/PostalAddress.php b/src/PostalAddress.php index 1434a53ed..383459f05 100644 --- a/src/PostalAddress.php +++ b/src/PostalAddress.php @@ -15,6 +15,25 @@ */ class PostalAddress extends BaseType implements ContactPointContract, StructuredValueContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The country. For example, USA. You can also provide the two-letter [ISO * 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1). @@ -62,45 +81,17 @@ public function addressRegion($addressRegion) } /** - * The post office box number for PO box addresses. - * - * @param string|string[] $postOfficeBoxNumber - * - * @return static - * - * @see http://schema.org/postOfficeBoxNumber - */ - public function postOfficeBoxNumber($postOfficeBoxNumber) - { - return $this->setProperty('postOfficeBoxNumber', $postOfficeBoxNumber); - } - - /** - * The postal code. For example, 94043. - * - * @param string|string[] $postalCode - * - * @return static - * - * @see http://schema.org/postalCode - */ - public function postalCode($postalCode) - { - return $this->setProperty('postalCode', $postalCode); - } - - /** - * The street address. For example, 1600 Amphitheatre Pkwy. + * An alias for the item. * - * @param string|string[] $streetAddress + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/streetAddress + * @see http://schema.org/alternateName */ - public function streetAddress($streetAddress) + public function alternateName($alternateName) { - return $this->setProperty('streetAddress', $streetAddress); + return $this->setProperty('alternateName', $alternateName); } /** @@ -164,6 +155,37 @@ public function contactType($contactType) return $this->setProperty('contactType', $contactType); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Email address. * @@ -207,220 +229,198 @@ public function hoursAvailable($hoursAvailable) } /** - * The product or service this support contact point is related to (such as - * product support for a particular product line). This can be a specific - * product or product line (e.g. "iPhone") or a general category of products - * or services (e.g. "smartphones"). - * - * @param Product|Product[]|string|string[] $productSupported - * - * @return static - * - * @see http://schema.org/productSupported - */ - public function productSupported($productSupported) - { - return $this->setProperty('productSupported', $productSupported); - } - - /** - * The geographic area where the service is provided. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/identifier */ - public function serviceArea($serviceArea) + public function identifier($identifier) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('identifier', $identifier); } /** - * The telephone number. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/image */ - public function telephone($telephone) + public function image($image) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('image', $image); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The post office box number for PO box addresses. * - * @param string|string[] $description + * @param string|string[] $postOfficeBoxNumber * * @return static * - * @see http://schema.org/description + * @see http://schema.org/postOfficeBoxNumber */ - public function description($description) + public function postOfficeBoxNumber($postOfficeBoxNumber) { - return $this->setProperty('description', $description); + return $this->setProperty('postOfficeBoxNumber', $postOfficeBoxNumber); } /** - * 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. + * The postal code. For example, 94043. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $postalCode * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/postalCode */ - public function disambiguatingDescription($disambiguatingDescription) + public function postalCode($postalCode) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('postalCode', $postalCode); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The product or service this support contact point is related to (such as + * product support for a particular product line). This can be a specific + * product or product line (e.g. "iPhone") or a general category of products + * or services (e.g. "smartphones"). * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Product|Product[]|string|string[] $productSupported * * @return static * - * @see http://schema.org/image + * @see http://schema.org/productSupported */ - public function image($image) + public function productSupported($productSupported) { - return $this->setProperty('image', $image); + return $this->setProperty('productSupported', $productSupported); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The geographic area where the service is provided. * - * @param string|string[] $name + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/name + * @see http://schema.org/serviceArea */ - public function name($name) + public function serviceArea($serviceArea) { - return $this->setProperty('name', $name); + return $this->setProperty('serviceArea', $serviceArea); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The street address. For example, 1600 Amphitheatre Pkwy. * - * @param Action|Action[] $potentialAction + * @param string|string[] $streetAddress * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/streetAddress */ - public function potentialAction($potentialAction) + public function streetAddress($streetAddress) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('streetAddress', $streetAddress); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/PreOrderAction.php b/src/PreOrderAction.php index 309204447..70b2544f3 100644 --- a/src/PreOrderAction.php +++ b/src/PreOrderAction.php @@ -16,107 +16,96 @@ class PreOrderAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * Indicates the current disposition of the Action. * - * @param float|float[]|int|int[]|string|string[] $price + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/price + * @see http://schema.org/actionStatus */ - public function price($price) + public function actionStatus($actionStatus) { - return $this->setProperty('price', $price); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $priceCurrency + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/additionalType */ - public function priceCurrency($priceCurrency) + public function additionalType($additionalType) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('additionalType', $additionalType); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/agent */ - public function priceSpecification($priceSpecification) + public function agent($agent) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -157,288 +146,299 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/instrument */ - public function participant($participant) + public function instrument($instrument) { - return $this->setProperty('participant', $participant); + return $this->setProperty('instrument', $instrument); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Thing|Thing[] $result + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/result + * @see http://schema.org/location */ - public function result($result) + public function location($location) { - return $this->setProperty('result', $result); + return $this->setProperty('location', $location); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/mainEntityOfPage */ - public function startTime($startTime) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Indicates a target EntryPoint for an Action. + * The name of the item. * - * @param EntryPoint|EntryPoint[] $target + * @param string|string[] $name * * @return static * - * @see http://schema.org/target + * @see http://schema.org/name */ - public function target($target) + public function name($name) { - return $this->setProperty('target', $target); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/object */ - public function additionalType($additionalType) + public function object($object) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('object', $object); } /** - * An alias for the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/participant */ - public function alternateName($alternateName) + public function participant($participant) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('participant', $participant); } /** - * A description of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $description + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/description + * @see http://schema.org/potentialAction */ - public function description($description) + public function potentialAction($potentialAction) { - return $this->setProperty('description', $description); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $disambiguatingDescription + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/price */ - public function disambiguatingDescription($disambiguatingDescription) + public function price($price) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('price', $price); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceCurrency */ - public function identifier($identifier) + public function priceCurrency($priceCurrency) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceSpecification */ - public function image($image) + public function priceSpecification($priceSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/PrependAction.php b/src/PrependAction.php index 060d13cde..797f4dfd6 100644 --- a/src/PrependAction.php +++ b/src/PrependAction.php @@ -17,75 +17,110 @@ class PrependAction extends BaseType implements InsertActionContract, AddActionContract, UpdateActionContract, ActionContract, ThingContract { /** - * A sub property of location. The final location of the object or the agent - * after the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $toLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/actionStatus */ - public function toLocation($toLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of object. The collection target of the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $collection + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/collection + * @see http://schema.org/additionalType */ - public function collection($collection) + public function additionalType($additionalType) { - return $this->setProperty('collection', $collection); + return $this->setProperty('additionalType', $additionalType); + } + + /** + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. + * + * @param Organization|Organization[]|Person|Person[] $agent + * + * @return static + * + * @see http://schema.org/agent + */ + public function agent($agent) + { + return $this->setProperty('agent', $agent); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); } /** * A sub property of object. The collection target of the action. * - * @param Thing|Thing[] $targetCollection + * @param Thing|Thing[] $collection * * @return static * - * @see http://schema.org/targetCollection + * @see http://schema.org/collection */ - public function targetCollection($targetCollection) + public function collection($collection) { - return $this->setProperty('targetCollection', $targetCollection); + return $this->setProperty('collection', $collection); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -126,288 +161,253 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $object + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/object + * @see http://schema.org/identifier */ - public function object($object) + public function identifier($identifier) { - return $this->setProperty('object', $object); + return $this->setProperty('identifier', $identifier); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/image */ - public function participant($participant) + public function image($image) { - return $this->setProperty('participant', $participant); + return $this->setProperty('image', $image); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/result */ - public function identifier($identifier) + public function result($result) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('result', $result); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/startTime */ - public function mainEntityOfPage($mainEntityOfPage) + public function startTime($startTime) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('startTime', $startTime); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates a target EntryPoint for an Action. * - * @param Action|Action[] $potentialAction + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/target */ - public function potentialAction($potentialAction) + public function target($target) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('target', $target); } /** - * 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. + * A sub property of object. The collection target of the action. * - * @param string|string[] $sameAs + * @param Thing|Thing[] $targetCollection * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/targetCollection */ - public function sameAs($sameAs) + public function targetCollection($targetCollection) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('targetCollection', $targetCollection); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/Preschool.php b/src/Preschool.php index c6915fc76..c3e4726aa 100644 --- a/src/Preschool.php +++ b/src/Preschool.php @@ -15,17 +15,22 @@ class Preschool extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { /** - * Alumni of an organization. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $alumni + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/alumni + * @see http://schema.org/additionalType */ - public function alumni($alumni) + public function additionalType($additionalType) { - return $this->setProperty('alumni', $alumni); + return $this->setProperty('additionalType', $additionalType); } /** @@ -57,6 +62,34 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + /** * The geographic area where a service or offered item is provided. * @@ -159,6 +192,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -390,6 +454,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -464,6 +561,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -537,6 +650,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -594,6 +721,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -646,6 +788,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -721,6 +879,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -751,203 +923,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/PresentationDigitalDocument.php b/src/PresentationDigitalDocument.php index af26816c8..56517c6a7 100644 --- a/src/PresentationDigitalDocument.php +++ b/src/PresentationDigitalDocument.php @@ -14,22 +14,6 @@ */ class PresentationDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract { - /** - * A permission related to the access to this document (e.g. permission to - * read or write an electronic document). For a public document, specify a - * grantee with an Audience with audienceType equal to "public". - * - * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission - * - * @return static - * - * @see http://schema.org/hasDigitalDocumentPermission - */ - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) - { - return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); - } - /** * The subject matter of the content. * @@ -174,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -189,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -480,6 +497,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -676,6 +724,22 @@ public function genre($genre) return $this->setProperty('genre', $genre); } + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + /** * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). @@ -705,6 +769,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -902,6 +999,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -932,6 +1045,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -962,6 +1089,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1103,6 +1245,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1185,6 +1343,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1306,6 +1478,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1349,190 +1535,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/PriceSpecification.php b/src/PriceSpecification.php index b4af1b732..10a39d2c9 100644 --- a/src/PriceSpecification.php +++ b/src/PriceSpecification.php @@ -18,354 +18,354 @@ class PriceSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** - * The interval and unit of measurement of ordering quantities for which the - * offer or price specification is valid. This allows e.g. specifying that a - * certain freight charge is valid only for a certain quantity. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/eligibleQuantity + * @see http://schema.org/additionalType */ - public function eligibleQuantity($eligibleQuantity) + public function additionalType($additionalType) { - return $this->setProperty('eligibleQuantity', $eligibleQuantity); + return $this->setProperty('additionalType', $additionalType); } /** - * The transaction volume, in a monetary unit, for which the offer or price - * specification is valid, e.g. for indicating a minimal purchasing volume, - * to express free shipping above a certain order volume, or to limit the - * acceptance of credit cards to purchases to a certain minimal amount. + * An alias for the item. * - * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/eligibleTransactionVolume + * @see http://schema.org/alternateName */ - public function eligibleTransactionVolume($eligibleTransactionVolume) + public function alternateName($alternateName) { - return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); + return $this->setProperty('alternateName', $alternateName); } /** - * The highest price if the price is a range. + * A description of the item. * - * @param float|float[]|int|int[] $maxPrice + * @param string|string[] $description * * @return static * - * @see http://schema.org/maxPrice + * @see http://schema.org/description */ - public function maxPrice($maxPrice) + public function description($description) { - return $this->setProperty('maxPrice', $maxPrice); + return $this->setProperty('description', $description); } /** - * The lowest price if the price is a range. + * 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. * - * @param float|float[]|int|int[] $minPrice + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/minPrice + * @see http://schema.org/disambiguatingDescription */ - public function minPrice($minPrice) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('minPrice', $minPrice); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * The interval and unit of measurement of ordering quantities for which the + * offer or price specification is valid. This allows e.g. specifying that a + * certain freight charge is valid only for a certain quantity. * - * @param float|float[]|int|int[]|string|string[] $price + * @param QuantitativeValue|QuantitativeValue[] $eligibleQuantity * * @return static * - * @see http://schema.org/price + * @see http://schema.org/eligibleQuantity */ - public function price($price) + public function eligibleQuantity($eligibleQuantity) { - return $this->setProperty('price', $price); + return $this->setProperty('eligibleQuantity', $eligibleQuantity); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The transaction volume, in a monetary unit, for which the offer or price + * specification is valid, e.g. for indicating a minimal purchasing volume, + * to express free shipping above a certain order volume, or to limit the + * acceptance of credit cards to purchases to a certain minimal amount. * - * @param string|string[] $priceCurrency + * @param PriceSpecification|PriceSpecification[] $eligibleTransactionVolume * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/eligibleTransactionVolume */ - public function priceCurrency($priceCurrency) + public function eligibleTransactionVolume($eligibleTransactionVolume) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); } /** - * The date when the item becomes valid. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/validFrom + * @see http://schema.org/identifier */ - public function validFrom($validFrom) + public function identifier($identifier) { - return $this->setProperty('validFrom', $validFrom); + return $this->setProperty('identifier', $identifier); } /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/validThrough + * @see http://schema.org/image */ - public function validThrough($validThrough) + public function image($image) { - return $this->setProperty('validThrough', $validThrough); + return $this->setProperty('image', $image); } /** - * Specifies whether the applicable value-added tax (VAT) is included in the - * price specification or not. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param bool|bool[] $valueAddedTaxIncluded + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/valueAddedTaxIncluded + * @see http://schema.org/mainEntityOfPage */ - public function valueAddedTaxIncluded($valueAddedTaxIncluded) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The highest price if the price is a range. * - * @param string|string[] $additionalType + * @param float|float[]|int|int[] $maxPrice * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/maxPrice */ - public function additionalType($additionalType) + public function maxPrice($maxPrice) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('maxPrice', $maxPrice); } /** - * An alias for the item. + * The lowest price if the price is a range. * - * @param string|string[] $alternateName + * @param float|float[]|int|int[] $minPrice * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/minPrice */ - public function alternateName($alternateName) + public function minPrice($minPrice) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('minPrice', $minPrice); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/price */ - public function identifier($identifier) + public function price($price) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('price', $price); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceCurrency */ - public function image($image) + public function priceCurrency($priceCurrency) { - return $this->setProperty('image', $image); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The date when the item becomes valid. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validFrom */ - public function sameAs($sameAs) + public function validFrom($validFrom) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validFrom', $validFrom); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. * - * @param string|string[] $url + * @param bool|bool[] $valueAddedTaxIncluded * * @return static * - * @see http://schema.org/url + * @see http://schema.org/valueAddedTaxIncluded */ - public function url($url) + public function valueAddedTaxIncluded($valueAddedTaxIncluded) { - return $this->setProperty('url', $url); + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); } } diff --git a/src/Product.php b/src/Product.php index 9f7a46e88..8bd62a42a 100644 --- a/src/Product.php +++ b/src/Product.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -51,6 +70,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An intended audience, i.e. a group for whom something was created. * @@ -151,6 +184,37 @@ public function depth($depth) return $this->setProperty('depth', $depth); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The GTIN-12 code of the product, or the product to which the offer * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a @@ -238,6 +302,39 @@ public function height($height) return $this->setProperty('height', $height); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another product (or multiple products) for which this * product is an accessory or spare part. @@ -327,6 +424,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The manufacturer of the product. * @@ -389,6 +502,20 @@ public function mpn($mpn) return $this->setProperty('mpn', $mpn); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -405,6 +532,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The product identifier, such as ISBN. For example: ``` meta * itemprop="productID" content="isbn:123-456-789" ```. @@ -491,6 +633,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a * product or service, or the product to which the offer refers. @@ -521,217 +679,59 @@ public function slogan($slogan) } /** - * The weight of the product or person. - * - * @param QuantitativeValue|QuantitativeValue[] $weight - * - * @return static - * - * @see http://schema.org/weight - */ - public function weight($weight) - { - return $this->setProperty('weight', $weight); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The weight of the product or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param QuantitativeValue|QuantitativeValue[] $weight * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/weight */ - public function subjectOf($subjectOf) + public function weight($weight) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('weight', $weight); } /** - * URL of the item. + * The width of the item. * - * @param string|string[] $url + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/url + * @see http://schema.org/width */ - public function url($url) + public function width($width) { - return $this->setProperty('url', $url); + return $this->setProperty('width', $width); } } diff --git a/src/ProductModel.php b/src/ProductModel.php index e208816f9..fc35d147d 100644 --- a/src/ProductModel.php +++ b/src/ProductModel.php @@ -14,52 +14,6 @@ */ class ProductModel extends BaseType implements ProductContract, ThingContract { - /** - * A pointer to a base product from which this product is a variant. It is - * safe to infer that the variant inherits all product features from the - * base model, unless defined locally. This is not transitive. - * - * @param ProductModel|ProductModel[] $isVariantOf - * - * @return static - * - * @see http://schema.org/isVariantOf - */ - public function isVariantOf($isVariantOf) - { - return $this->setProperty('isVariantOf', $isVariantOf); - } - - /** - * A pointer from a previous, often discontinued variant of the product to - * its newer variant. - * - * @param ProductModel|ProductModel[] $predecessorOf - * - * @return static - * - * @see http://schema.org/predecessorOf - */ - public function predecessorOf($predecessorOf) - { - return $this->setProperty('predecessorOf', $predecessorOf); - } - - /** - * A pointer from a newer variant of a product to its previous, often - * discontinued predecessor. - * - * @param ProductModel|ProductModel[] $successorOf - * - * @return static - * - * @see http://schema.org/successorOf - */ - public function successorOf($successorOf) - { - return $this->setProperty('successorOf', $successorOf); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -82,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -97,6 +70,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An intended audience, i.e. a group for whom something was created. * @@ -197,6 +184,37 @@ public function depth($depth) return $this->setProperty('depth', $depth); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The GTIN-12 code of the product, or the product to which the offer * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a @@ -284,6 +302,39 @@ public function height($height) return $this->setProperty('height', $height); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another product (or multiple products) for which this * product is an accessory or spare part. @@ -343,6 +394,22 @@ public function isSimilarTo($isSimilarTo) return $this->setProperty('isSimilarTo', $isSimilarTo); } + /** + * A pointer to a base product from which this product is a variant. It is + * safe to infer that the variant inherits all product features from the + * base model, unless defined locally. This is not transitive. + * + * @param ProductModel|ProductModel[] $isVariantOf + * + * @return static + * + * @see http://schema.org/isVariantOf + */ + public function isVariantOf($isVariantOf) + { + return $this->setProperty('isVariantOf', $isVariantOf); + } + /** * A predefined value from OfferItemCondition or a textual description of * the condition of the product or service, or the products or services @@ -373,6 +440,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The manufacturer of the product. * @@ -435,6 +518,20 @@ public function mpn($mpn) return $this->setProperty('mpn', $mpn); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -451,6 +548,36 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * A pointer from a previous, often discontinued variant of the product to + * its newer variant. + * + * @param ProductModel|ProductModel[] $predecessorOf + * + * @return static + * + * @see http://schema.org/predecessorOf + */ + public function predecessorOf($predecessorOf) + { + return $this->setProperty('predecessorOf', $predecessorOf); + } + /** * The product identifier, such as ISBN. For example: ``` meta * itemprop="productID" content="isbn:123-456-789" ```. @@ -537,6 +664,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a * product or service, or the product to which the offer refers. @@ -567,217 +710,74 @@ public function slogan($slogan) } /** - * The weight of the product or person. - * - * @param QuantitativeValue|QuantitativeValue[] $weight - * - * @return static - * - * @see http://schema.org/weight - */ - public function weight($weight) - { - return $this->setProperty('weight', $weight); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A pointer from a newer variant of a product to its previous, often + * discontinued predecessor. * - * @param Action|Action[] $potentialAction + * @param ProductModel|ProductModel[] $successorOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/successorOf */ - public function potentialAction($potentialAction) + public function successorOf($successorOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('successorOf', $successorOf); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The weight of the product or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param QuantitativeValue|QuantitativeValue[] $weight * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/weight */ - public function subjectOf($subjectOf) + public function weight($weight) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('weight', $weight); } /** - * URL of the item. + * The width of the item. * - * @param string|string[] $url + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/url + * @see http://schema.org/width */ - public function url($url) + public function width($width) { - return $this->setProperty('url', $url); + return $this->setProperty('width', $width); } } diff --git a/src/ProfessionalService.php b/src/ProfessionalService.php index 684529fcf..2133360a0 100644 --- a/src/ProfessionalService.php +++ b/src/ProfessionalService.php @@ -26,126 +26,104 @@ class ProfessionalService extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -190,6 +168,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -233,6 +246,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -250,6 +328,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -436,22 +545,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -481,6 +618,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -497,6 +681,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -555,6 +754,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -569,6 +799,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -628,6 +900,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -656,6 +942,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -686,664 +1015,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ProfilePage.php b/src/ProfilePage.php index d6722db31..5b8c84789 100644 --- a/src/ProfilePage.php +++ b/src/ProfilePage.php @@ -14,176 +14,6 @@ */ class ProfilePage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -328,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -343,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -444,6 +307,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -634,6 +512,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -860,13 +769,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -996,6 +938,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1041,6 +998,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1056,6 +1027,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1086,6 +1073,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1116,6 +1117,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1214,6 +1244,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1243,6 +1287,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1257,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1274,6 +1349,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1323,6 +1428,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1339,6 +1497,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1460,6 +1632,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1503,190 +1689,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ProgramMembership.php b/src/ProgramMembership.php index 3e5075fc2..532affe61 100644 --- a/src/ProgramMembership.php +++ b/src/ProgramMembership.php @@ -14,78 +14,6 @@ */ class ProgramMembership extends BaseType implements IntangibleContract, ThingContract { - /** - * The organization (airline, travelers' club, etc.) the membership is made - * with. - * - * @param Organization|Organization[] $hostingOrganization - * - * @return static - * - * @see http://schema.org/hostingOrganization - */ - public function hostingOrganization($hostingOrganization) - { - return $this->setProperty('hostingOrganization', $hostingOrganization); - } - - /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. - * - * @param Organization|Organization[]|Person|Person[] $member - * - * @return static - * - * @see http://schema.org/member - */ - public function member($member) - { - return $this->setProperty('member', $member); - } - - /** - * A member of this organization. - * - * @param Organization|Organization[]|Person|Person[] $members - * - * @return static - * - * @see http://schema.org/members - */ - public function members($members) - { - return $this->setProperty('members', $members); - } - - /** - * A unique identifier for the membership. - * - * @param string|string[] $membershipNumber - * - * @return static - * - * @see http://schema.org/membershipNumber - */ - public function membershipNumber($membershipNumber) - { - return $this->setProperty('membershipNumber', $membershipNumber); - } - - /** - * The program providing the membership. - * - * @param string|string[] $programName - * - * @return static - * - * @see http://schema.org/programName - */ - public function programName($programName) - { - return $this->setProperty('programName', $programName); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -150,6 +78,21 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The organization (airline, travelers' club, etc.) the membership is made + * with. + * + * @param Organization|Organization[] $hostingOrganization + * + * @return static + * + * @see http://schema.org/hostingOrganization + */ + public function hostingOrganization($hostingOrganization) + { + return $this->setProperty('hostingOrganization', $hostingOrganization); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -199,6 +142,49 @@ public function mainEntityOfPage($mainEntityOfPage) return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } + /** + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. + * + * @param Organization|Organization[]|Person|Person[] $member + * + * @return static + * + * @see http://schema.org/member + */ + public function member($member) + { + return $this->setProperty('member', $member); + } + + /** + * A member of this organization. + * + * @param Organization|Organization[]|Person|Person[] $members + * + * @return static + * + * @see http://schema.org/members + */ + public function members($members) + { + return $this->setProperty('members', $members); + } + + /** + * A unique identifier for the membership. + * + * @param string|string[] $membershipNumber + * + * @return static + * + * @see http://schema.org/membershipNumber + */ + public function membershipNumber($membershipNumber) + { + return $this->setProperty('membershipNumber', $membershipNumber); + } + /** * The name of the item. * @@ -228,6 +214,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The program providing the membership. + * + * @param string|string[] $programName + * + * @return static + * + * @see http://schema.org/programName + */ + public function programName($programName) + { + return $this->setProperty('programName', $programName); + } + /** * 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 diff --git a/src/PropertyValue.php b/src/PropertyValue.php index 6f060cfbd..d3cb24b91 100644 --- a/src/PropertyValue.php +++ b/src/PropertyValue.php @@ -21,128 +21,6 @@ */ class PropertyValue extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { - /** - * The upper value of some characteristic or property. - * - * @param float|float[]|int|int[] $maxValue - * - * @return static - * - * @see http://schema.org/maxValue - */ - public function maxValue($maxValue) - { - return $this->setProperty('maxValue', $maxValue); - } - - /** - * The lower value of some characteristic or property. - * - * @param float|float[]|int|int[] $minValue - * - * @return static - * - * @see http://schema.org/minValue - */ - public function minValue($minValue) - { - return $this->setProperty('minValue', $minValue); - } - - /** - * A commonly used identifier for the characteristic represented by the - * property, e.g. a manufacturer or a standard code for a property. - * propertyID can be - * (1) a prefixed string, mainly meant to be used with standards for product - * properties; (2) a site-specific, non-prefixed string (e.g. the primary - * key of the property or the vendor-specific id of the property), or (3) - * a URL indicating the type of the property, either pointing to an external - * vocabulary, or a Web resource that describes the property (e.g. a - * glossary entry). - * Standards bodies should promote a standard prefix for the identifiers of - * properties from their standards. - * - * @param string|string[] $propertyID - * - * @return static - * - * @see http://schema.org/propertyID - */ - public function propertyID($propertyID) - { - return $this->setProperty('propertyID', $propertyID); - } - - /** - * The unit of measurement given using the UN/CEFACT Common Code (3 - * characters) or a URL. Other codes than the UN/CEFACT Common Code may be - * used with a prefix followed by a colon. - * - * @param string|string[] $unitCode - * - * @return static - * - * @see http://schema.org/unitCode - */ - public function unitCode($unitCode) - { - return $this->setProperty('unitCode', $unitCode); - } - - /** - * A string or text indicating the unit of measurement. Useful if you cannot - * provide a standard unit code for - * unitCode. - * - * @param string|string[] $unitText - * - * @return static - * - * @see http://schema.org/unitText - */ - public function unitText($unitText) - { - return $this->setProperty('unitText', $unitText); - } - - /** - * The value of the quantitative value or property value node. - * - * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type - * for values is 'Number'. - * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or - * 'StructuredValue'. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value - * - * @return static - * - * @see http://schema.org/value - */ - public function value($value) - { - return $this->setProperty('value', $value); - } - - /** - * A pointer to a secondary value that provides additional information on - * the original value, e.g. a reference temperature. - * - * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference - * - * @return static - * - * @see http://schema.org/valueReference - */ - public function valueReference($valueReference) - { - return $this->setProperty('valueReference', $valueReference); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -256,6 +134,34 @@ public function mainEntityOfPage($mainEntityOfPage) return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } + /** + * The upper value of some characteristic or property. + * + * @param float|float[]|int|int[] $maxValue + * + * @return static + * + * @see http://schema.org/maxValue + */ + public function maxValue($maxValue) + { + return $this->setProperty('maxValue', $maxValue); + } + + /** + * The lower value of some characteristic or property. + * + * @param float|float[]|int|int[] $minValue + * + * @return static + * + * @see http://schema.org/minValue + */ + public function minValue($minValue) + { + return $this->setProperty('minValue', $minValue); + } + /** * The name of the item. * @@ -285,6 +191,30 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A commonly used identifier for the characteristic represented by the + * property, e.g. a manufacturer or a standard code for a property. + * propertyID can be + * (1) a prefixed string, mainly meant to be used with standards for product + * properties; (2) a site-specific, non-prefixed string (e.g. the primary + * key of the property or the vendor-specific id of the property), or (3) + * a URL indicating the type of the property, either pointing to an external + * vocabulary, or a Web resource that describes the property (e.g. a + * glossary entry). + * Standards bodies should promote a standard prefix for the identifiers of + * properties from their standards. + * + * @param string|string[] $propertyID + * + * @return static + * + * @see http://schema.org/propertyID + */ + public function propertyID($propertyID) + { + return $this->setProperty('propertyID', $propertyID); + } + /** * 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 @@ -315,6 +245,38 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The unit of measurement given using the UN/CEFACT Common Code (3 + * characters) or a URL. Other codes than the UN/CEFACT Common Code may be + * used with a prefix followed by a colon. + * + * @param string|string[] $unitCode + * + * @return static + * + * @see http://schema.org/unitCode + */ + public function unitCode($unitCode) + { + return $this->setProperty('unitCode', $unitCode); + } + + /** + * A string or text indicating the unit of measurement. Useful if you cannot + * provide a standard unit code for + * unitCode. + * + * @param string|string[] $unitText + * + * @return static + * + * @see http://schema.org/unitText + */ + public function unitText($unitText) + { + return $this->setProperty('unitText', $unitText); + } + /** * URL of the item. * @@ -329,4 +291,42 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The value of the quantitative value or property value node. + * + * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type + * for values is 'Number'. + * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or + * 'StructuredValue'. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value + * + * @return static + * + * @see http://schema.org/value + */ + public function value($value) + { + return $this->setProperty('value', $value); + } + + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + } diff --git a/src/PropertyValueSpecification.php b/src/PropertyValueSpecification.php index 69050fc1d..20af6b14d 100644 --- a/src/PropertyValueSpecification.php +++ b/src/PropertyValueSpecification.php @@ -14,352 +14,352 @@ class PropertyValueSpecification extends BaseType implements IntangibleContract, ThingContract { /** - * The default value of the input. For properties that expect a literal, - * the default is a literal value, for properties that expect an object, - * it's an ID reference to one of the current values. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[]|string|string[] $defaultValue + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/defaultValue + * @see http://schema.org/additionalType */ - public function defaultValue($defaultValue) + public function additionalType($additionalType) { - return $this->setProperty('defaultValue', $defaultValue); + return $this->setProperty('additionalType', $additionalType); } /** - * The upper value of some characteristic or property. + * An alias for the item. * - * @param float|float[]|int|int[] $maxValue + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/maxValue + * @see http://schema.org/alternateName */ - public function maxValue($maxValue) + public function alternateName($alternateName) { - return $this->setProperty('maxValue', $maxValue); + return $this->setProperty('alternateName', $alternateName); } /** - * The lower value of some characteristic or property. + * The default value of the input. For properties that expect a literal, + * the default is a literal value, for properties that expect an object, + * it's an ID reference to one of the current values. * - * @param float|float[]|int|int[] $minValue + * @param Thing|Thing[]|string|string[] $defaultValue * * @return static * - * @see http://schema.org/minValue + * @see http://schema.org/defaultValue */ - public function minValue($minValue) + public function defaultValue($defaultValue) { - return $this->setProperty('minValue', $minValue); + return $this->setProperty('defaultValue', $defaultValue); } /** - * Whether multiple values are allowed for the property. Default is false. + * A description of the item. * - * @param bool|bool[] $multipleValues + * @param string|string[] $description * * @return static * - * @see http://schema.org/multipleValues + * @see http://schema.org/description */ - public function multipleValues($multipleValues) + public function description($description) { - return $this->setProperty('multipleValues', $multipleValues); + return $this->setProperty('description', $description); } /** - * Whether or not a property is mutable. Default is false. Specifying this - * for a property that also has a value makes it act similar to a "hidden" - * input in an HTML form. + * 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. * - * @param bool|bool[] $readonlyValue + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/readonlyValue + * @see http://schema.org/disambiguatingDescription */ - public function readonlyValue($readonlyValue) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('readonlyValue', $readonlyValue); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The stepValue attribute indicates the granularity that is expected (and - * required) of the value in a PropertyValueSpecification. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param float|float[]|int|int[] $stepValue + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/stepValue + * @see http://schema.org/identifier */ - public function stepValue($stepValue) + public function identifier($identifier) { - return $this->setProperty('stepValue', $stepValue); + return $this->setProperty('identifier', $identifier); } /** - * Specifies the allowed range for number of characters in a literal value. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param float|float[]|int|int[] $valueMaxLength + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/valueMaxLength + * @see http://schema.org/image */ - public function valueMaxLength($valueMaxLength) + public function image($image) { - return $this->setProperty('valueMaxLength', $valueMaxLength); + return $this->setProperty('image', $image); } /** - * Specifies the minimum allowed range for number of characters in a literal - * value. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param float|float[]|int|int[] $valueMinLength + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/valueMinLength + * @see http://schema.org/mainEntityOfPage */ - public function valueMinLength($valueMinLength) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('valueMinLength', $valueMinLength); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Indicates the name of the PropertyValueSpecification to be used in URL - * templates and form encoding in a manner analogous to HTML's input@name. + * The upper value of some characteristic or property. * - * @param string|string[] $valueName + * @param float|float[]|int|int[] $maxValue * * @return static * - * @see http://schema.org/valueName + * @see http://schema.org/maxValue */ - public function valueName($valueName) + public function maxValue($maxValue) { - return $this->setProperty('valueName', $valueName); + return $this->setProperty('maxValue', $maxValue); } /** - * Specifies a regular expression for testing literal values according to - * the HTML spec. + * The lower value of some characteristic or property. * - * @param string|string[] $valuePattern + * @param float|float[]|int|int[] $minValue * * @return static * - * @see http://schema.org/valuePattern + * @see http://schema.org/minValue */ - public function valuePattern($valuePattern) + public function minValue($minValue) { - return $this->setProperty('valuePattern', $valuePattern); + return $this->setProperty('minValue', $minValue); } /** - * Whether the property must be filled in to complete the action. Default - * is false. + * Whether multiple values are allowed for the property. Default is false. * - * @param bool|bool[] $valueRequired + * @param bool|bool[] $multipleValues * * @return static * - * @see http://schema.org/valueRequired + * @see http://schema.org/multipleValues */ - public function valueRequired($valueRequired) + public function multipleValues($multipleValues) { - return $this->setProperty('valueRequired', $valueRequired); + return $this->setProperty('multipleValues', $multipleValues); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * Whether or not a property is mutable. Default is false. Specifying this + * for a property that also has a value makes it act similar to a "hidden" + * input in an HTML form. * - * @param string|string[] $description + * @param bool|bool[] $readonlyValue * * @return static * - * @see http://schema.org/description + * @see http://schema.org/readonlyValue */ - public function description($description) + public function readonlyValue($readonlyValue) { - return $this->setProperty('description', $description); + return $this->setProperty('readonlyValue', $readonlyValue); } /** - * 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. + * 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. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/sameAs */ - public function disambiguatingDescription($disambiguatingDescription) + public function sameAs($sameAs) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('sameAs', $sameAs); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The stepValue attribute indicates the granularity that is expected (and + * required) of the value in a PropertyValueSpecification. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param float|float[]|int|int[] $stepValue * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/stepValue */ - public function identifier($identifier) + public function stepValue($stepValue) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('stepValue', $stepValue); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/image + * @see http://schema.org/subjectOf */ - public function image($image) + public function subjectOf($subjectOf) { - return $this->setProperty('image', $image); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $url * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/url */ - public function mainEntityOfPage($mainEntityOfPage) + public function url($url) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('url', $url); } /** - * The name of the item. + * Specifies the allowed range for number of characters in a literal value. * - * @param string|string[] $name + * @param float|float[]|int|int[] $valueMaxLength * * @return static * - * @see http://schema.org/name + * @see http://schema.org/valueMaxLength */ - public function name($name) + public function valueMaxLength($valueMaxLength) { - return $this->setProperty('name', $name); + return $this->setProperty('valueMaxLength', $valueMaxLength); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Specifies the minimum allowed range for number of characters in a literal + * value. * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[] $valueMinLength * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/valueMinLength */ - public function potentialAction($potentialAction) + public function valueMinLength($valueMinLength) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('valueMinLength', $valueMinLength); } /** - * 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. + * Indicates the name of the PropertyValueSpecification to be used in URL + * templates and form encoding in a manner analogous to HTML's input@name. * - * @param string|string[] $sameAs + * @param string|string[] $valueName * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/valueName */ - public function sameAs($sameAs) + public function valueName($valueName) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('valueName', $valueName); } /** - * A CreativeWork or Event about this Thing. + * Specifies a regular expression for testing literal values according to + * the HTML spec. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $valuePattern * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/valuePattern */ - public function subjectOf($subjectOf) + public function valuePattern($valuePattern) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('valuePattern', $valuePattern); } /** - * URL of the item. + * Whether the property must be filled in to complete the action. Default + * is false. * - * @param string|string[] $url + * @param bool|bool[] $valueRequired * * @return static * - * @see http://schema.org/url + * @see http://schema.org/valueRequired */ - public function url($url) + public function valueRequired($valueRequired) { - return $this->setProperty('url', $url); + return $this->setProperty('valueRequired', $valueRequired); } } diff --git a/src/PublicSwimmingPool.php b/src/PublicSwimmingPool.php index c9e133f4b..5b094cd74 100644 --- a/src/PublicSwimmingPool.php +++ b/src/PublicSwimmingPool.php @@ -17,126 +17,104 @@ class PublicSwimmingPool extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/PublicationEvent.php b/src/PublicationEvent.php index ac9d7462b..7e56c0753 100644 --- a/src/PublicationEvent.php +++ b/src/PublicationEvent.php @@ -15,48 +15,6 @@ */ class PublicationEvent extends BaseType implements EventContract, ThingContract { - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $free - * - * @return static - * - * @see http://schema.org/free - */ - public function free($free) - { - return $this->setProperty('free', $free); - } - - /** - * A flag to signal that the item, event, or place is accessible for free. - * - * @param bool|bool[] $isAccessibleForFree - * - * @return static - * - * @see http://schema.org/isAccessibleForFree - */ - public function isAccessibleForFree($isAccessibleForFree) - { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); - } - - /** - * A broadcast service associated with the publication event. - * - * @param BroadcastService|BroadcastService[] $publishedOn - * - * @return static - * - * @see http://schema.org/publishedOn - */ - public function publishedOn($publishedOn) - { - return $this->setProperty('publishedOn', $publishedOn); - } - /** * The subject matter of the content. * @@ -87,6 +45,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -102,6 +79,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -173,6 +164,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -189,6 +194,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -248,6 +270,20 @@ public function eventStatus($eventStatus) return $this->setProperty('eventStatus', $eventStatus); } + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $free + * + * @return static + * + * @see http://schema.org/free + */ + public function free($free) + { + return $this->setProperty('free', $free); + } + /** * A person or organization that supports (sponsors) something through some * kind of financial contribution. @@ -263,6 +299,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -309,6 +378,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -323,6 +408,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -383,6 +482,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -401,6 +515,20 @@ public function previousStartDate($previousStartDate) return $this->setProperty('previousStartDate', $previousStartDate); } + /** + * A broadcast service associated with the publication event. + * + * @param BroadcastService|BroadcastService[] $publishedOn + * + * @return static + * + * @see http://schema.org/publishedOn + */ + public function publishedOn($publishedOn) + { + return $this->setProperty('publishedOn', $publishedOn); + } + /** * The CreativeWork that captured all or part of this Event. * @@ -443,6 +571,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -505,6 +649,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -551,6 +709,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -582,190 +754,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/PublicationIssue.php b/src/PublicationIssue.php index b6ee5a053..cfaf974bd 100644 --- a/src/PublicationIssue.php +++ b/src/PublicationIssue.php @@ -18,63 +18,6 @@ */ class PublicationIssue extends BaseType implements CreativeWorkContract, ThingContract { - /** - * Identifies the issue of publication; for example, "iii" or "2". - * - * @param int|int[]|string|string[] $issueNumber - * - * @return static - * - * @see http://schema.org/issueNumber - */ - public function issueNumber($issueNumber) - { - return $this->setProperty('issueNumber', $issueNumber); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - /** * The subject matter of the content. * @@ -219,6 +162,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -234,6 +196,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -525,6 +501,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -750,6 +757,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -872,6 +912,20 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * Identifies the issue of publication; for example, "iii" or "2". + * + * @param int|int[]|string|string[] $issueNumber + * + * @return static + * + * @see http://schema.org/issueNumber + */ + public function issueNumber($issueNumber) + { + return $this->setProperty('issueNumber', $issueNumber); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -947,6 +1001,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -977,6 +1047,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -993,6 +1077,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1007,6 +1134,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1148,6 +1290,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1230,6 +1388,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1351,6 +1523,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1394,190 +1580,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/PublicationVolume.php b/src/PublicationVolume.php index 06e2e6635..900455b97 100644 --- a/src/PublicationVolume.php +++ b/src/PublicationVolume.php @@ -18,64 +18,6 @@ */ class PublicationVolume extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Identifies the volume of publication or multi-part work; for example, - * "iii" or "2". - * - * @param int|int[]|string|string[] $volumeNumber - * - * @return static - * - * @see http://schema.org/volumeNumber - */ - public function volumeNumber($volumeNumber) - { - return $this->setProperty('volumeNumber', $volumeNumber); - } - /** * The subject matter of the content. * @@ -220,6 +162,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -235,6 +196,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -526,6 +501,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -751,6 +757,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -948,6 +987,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -978,6 +1033,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -994,6 +1063,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1008,6 +1120,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1149,6 +1276,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1231,6 +1374,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1352,6 +1509,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1381,204 +1552,33 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * Identifies the volume of publication or multi-part work; for example, + * "iii" or "2". * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[]|string|string[] $volumeNumber * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/volumeNumber */ - public function subjectOf($subjectOf) + public function volumeNumber($volumeNumber) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('volumeNumber', $volumeNumber); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/QAPage.php b/src/QAPage.php index c4809b40d..214567a8e 100644 --- a/src/QAPage.php +++ b/src/QAPage.php @@ -16,176 +16,6 @@ */ class QAPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -330,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -345,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -446,6 +309,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -636,6 +514,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -862,13 +771,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -998,6 +940,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1043,6 +1000,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1058,6 +1029,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1088,6 +1075,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1118,6 +1119,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1216,6 +1246,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1245,6 +1289,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1259,6 +1318,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1276,6 +1351,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1325,6 +1430,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1341,6 +1499,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1462,6 +1634,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1505,190 +1691,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/QualitativeValue.php b/src/QualitativeValue.php index 24a6e982c..2e03092f5 100644 --- a/src/QualitativeValue.php +++ b/src/QualitativeValue.php @@ -38,205 +38,175 @@ public function additionalProperty($additionalProperty) } /** - * This ordering relation for qualitative values indicates that the subject - * is equal to the object. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QualitativeValue|QualitativeValue[] $equal + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/equal + * @see http://schema.org/additionalType */ - public function equal($equal) + public function additionalType($additionalType) { - return $this->setProperty('equal', $equal); + return $this->setProperty('additionalType', $additionalType); } /** - * This ordering relation for qualitative values indicates that the subject - * is greater than the object. + * An alias for the item. * - * @param QualitativeValue|QualitativeValue[] $greater + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/greater + * @see http://schema.org/alternateName */ - public function greater($greater) + public function alternateName($alternateName) { - return $this->setProperty('greater', $greater); + return $this->setProperty('alternateName', $alternateName); } /** - * This ordering relation for qualitative values indicates that the subject - * is greater than or equal to the object. + * A description of the item. * - * @param QualitativeValue|QualitativeValue[] $greaterOrEqual + * @param string|string[] $description * * @return static * - * @see http://schema.org/greaterOrEqual + * @see http://schema.org/description */ - public function greaterOrEqual($greaterOrEqual) + public function description($description) { - return $this->setProperty('greaterOrEqual', $greaterOrEqual); + return $this->setProperty('description', $description); } /** - * This ordering relation for qualitative values indicates that the subject - * is lesser than the object. + * 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. * - * @param QualitativeValue|QualitativeValue[] $lesser + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/lesser + * @see http://schema.org/disambiguatingDescription */ - public function lesser($lesser) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('lesser', $lesser); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** * This ordering relation for qualitative values indicates that the subject - * is lesser than or equal to the object. + * is equal to the object. * - * @param QualitativeValue|QualitativeValue[] $lesserOrEqual + * @param QualitativeValue|QualitativeValue[] $equal * * @return static * - * @see http://schema.org/lesserOrEqual + * @see http://schema.org/equal */ - public function lesserOrEqual($lesserOrEqual) + public function equal($equal) { - return $this->setProperty('lesserOrEqual', $lesserOrEqual); + return $this->setProperty('equal', $equal); } /** * This ordering relation for qualitative values indicates that the subject - * is not equal to the object. - * - * @param QualitativeValue|QualitativeValue[] $nonEqual - * - * @return static - * - * @see http://schema.org/nonEqual - */ - public function nonEqual($nonEqual) - { - return $this->setProperty('nonEqual', $nonEqual); - } - - /** - * A pointer to a secondary value that provides additional information on - * the original value, e.g. a reference temperature. - * - * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference - * - * @return static - * - * @see http://schema.org/valueReference - */ - public function valueReference($valueReference) - { - return $this->setProperty('valueReference', $valueReference); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * is greater than the object. * - * @param string|string[] $additionalType + * @param QualitativeValue|QualitativeValue[] $greater * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/greater */ - public function additionalType($additionalType) + public function greater($greater) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('greater', $greater); } /** - * An alias for the item. + * This ordering relation for qualitative values indicates that the subject + * is greater than or equal to the object. * - * @param string|string[] $alternateName + * @param QualitativeValue|QualitativeValue[] $greaterOrEqual * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/greaterOrEqual */ - public function alternateName($alternateName) + public function greaterOrEqual($greaterOrEqual) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('greaterOrEqual', $greaterOrEqual); } /** - * A description of the item. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $description + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/description + * @see http://schema.org/identifier */ - public function description($description) + public function identifier($identifier) { - return $this->setProperty('description', $description); + return $this->setProperty('identifier', $identifier); } /** - * 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. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $disambiguatingDescription + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/image */ - public function disambiguatingDescription($disambiguatingDescription) + public function image($image) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('image', $image); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * This ordering relation for qualitative values indicates that the subject + * is lesser than the object. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param QualitativeValue|QualitativeValue[] $lesser * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/lesser */ - public function identifier($identifier) + public function lesser($lesser) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('lesser', $lesser); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * This ordering relation for qualitative values indicates that the subject + * is lesser than or equal to the object. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param QualitativeValue|QualitativeValue[] $lesserOrEqual * * @return static * - * @see http://schema.org/image + * @see http://schema.org/lesserOrEqual */ - public function image($image) + public function lesserOrEqual($lesserOrEqual) { - return $this->setProperty('image', $image); + return $this->setProperty('lesserOrEqual', $lesserOrEqual); } /** @@ -269,6 +239,21 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * This ordering relation for qualitative values indicates that the subject + * is not equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $nonEqual + * + * @return static + * + * @see http://schema.org/nonEqual + */ + public function nonEqual($nonEqual) + { + return $this->setProperty('nonEqual', $nonEqual); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -328,4 +313,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + } diff --git a/src/QuantitativeValue.php b/src/QuantitativeValue.php index 877a020e6..1e3bc1dc1 100644 --- a/src/QuantitativeValue.php +++ b/src/QuantitativeValue.php @@ -36,104 +36,6 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } - /** - * The upper value of some characteristic or property. - * - * @param float|float[]|int|int[] $maxValue - * - * @return static - * - * @see http://schema.org/maxValue - */ - public function maxValue($maxValue) - { - return $this->setProperty('maxValue', $maxValue); - } - - /** - * The lower value of some characteristic or property. - * - * @param float|float[]|int|int[] $minValue - * - * @return static - * - * @see http://schema.org/minValue - */ - public function minValue($minValue) - { - return $this->setProperty('minValue', $minValue); - } - - /** - * The unit of measurement given using the UN/CEFACT Common Code (3 - * characters) or a URL. Other codes than the UN/CEFACT Common Code may be - * used with a prefix followed by a colon. - * - * @param string|string[] $unitCode - * - * @return static - * - * @see http://schema.org/unitCode - */ - public function unitCode($unitCode) - { - return $this->setProperty('unitCode', $unitCode); - } - - /** - * A string or text indicating the unit of measurement. Useful if you cannot - * provide a standard unit code for - * unitCode. - * - * @param string|string[] $unitText - * - * @return static - * - * @see http://schema.org/unitText - */ - public function unitText($unitText) - { - return $this->setProperty('unitText', $unitText); - } - - /** - * The value of the quantitative value or property value node. - * - * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type - * for values is 'Number'. - * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or - * 'StructuredValue'. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value - * - * @return static - * - * @see http://schema.org/value - */ - public function value($value) - { - return $this->setProperty('value', $value); - } - - /** - * A pointer to a secondary value that provides additional information on - * the original value, e.g. a reference temperature. - * - * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference - * - * @return static - * - * @see http://schema.org/valueReference - */ - public function valueReference($valueReference) - { - return $this->setProperty('valueReference', $valueReference); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -247,6 +149,34 @@ public function mainEntityOfPage($mainEntityOfPage) return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } + /** + * The upper value of some characteristic or property. + * + * @param float|float[]|int|int[] $maxValue + * + * @return static + * + * @see http://schema.org/maxValue + */ + public function maxValue($maxValue) + { + return $this->setProperty('maxValue', $maxValue); + } + + /** + * The lower value of some characteristic or property. + * + * @param float|float[]|int|int[] $minValue + * + * @return static + * + * @see http://schema.org/minValue + */ + public function minValue($minValue) + { + return $this->setProperty('minValue', $minValue); + } + /** * The name of the item. * @@ -306,6 +236,38 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The unit of measurement given using the UN/CEFACT Common Code (3 + * characters) or a URL. Other codes than the UN/CEFACT Common Code may be + * used with a prefix followed by a colon. + * + * @param string|string[] $unitCode + * + * @return static + * + * @see http://schema.org/unitCode + */ + public function unitCode($unitCode) + { + return $this->setProperty('unitCode', $unitCode); + } + + /** + * A string or text indicating the unit of measurement. Useful if you cannot + * provide a standard unit code for + * unitCode. + * + * @param string|string[] $unitText + * + * @return static + * + * @see http://schema.org/unitText + */ + public function unitText($unitText) + { + return $this->setProperty('unitText', $unitText); + } + /** * URL of the item. * @@ -320,4 +282,42 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The value of the quantitative value or property value node. + * + * * For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type + * for values is 'Number'. + * * For [[PropertyValue]], it can be 'Text;', 'Number', 'Boolean', or + * 'StructuredValue'. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param StructuredValue|StructuredValue[]|bool|bool[]|float|float[]|int|int[]|string|string[] $value + * + * @return static + * + * @see http://schema.org/value + */ + public function value($value) + { + return $this->setProperty('value', $value); + } + + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + } diff --git a/src/QuantitativeValueDistribution.php b/src/QuantitativeValueDistribution.php index 49d1585ae..626dbf4ee 100644 --- a/src/QuantitativeValueDistribution.php +++ b/src/QuantitativeValueDistribution.php @@ -14,76 +14,6 @@ */ class QuantitativeValueDistribution extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { - /** - * The median value. - * - * @param float|float[]|int|int[] $median - * - * @return static - * - * @see http://schema.org/median - */ - public function median($median) - { - return $this->setProperty('median', $median); - } - - /** - * The 10th percentile value. - * - * @param float|float[]|int|int[] $percentile10 - * - * @return static - * - * @see http://schema.org/percentile10 - */ - public function percentile10($percentile10) - { - return $this->setProperty('percentile10', $percentile10); - } - - /** - * The 25th percentile value. - * - * @param float|float[]|int|int[] $percentile25 - * - * @return static - * - * @see http://schema.org/percentile25 - */ - public function percentile25($percentile25) - { - return $this->setProperty('percentile25', $percentile25); - } - - /** - * The 75th percentile value. - * - * @param float|float[]|int|int[] $percentile75 - * - * @return static - * - * @see http://schema.org/percentile75 - */ - public function percentile75($percentile75) - { - return $this->setProperty('percentile75', $percentile75); - } - - /** - * The 90th percentile value. - * - * @param float|float[]|int|int[] $percentile90 - * - * @return static - * - * @see http://schema.org/percentile90 - */ - public function percentile90($percentile90) - { - return $this->setProperty('percentile90', $percentile90); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -197,6 +127,20 @@ public function mainEntityOfPage($mainEntityOfPage) return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } + /** + * The median value. + * + * @param float|float[]|int|int[] $median + * + * @return static + * + * @see http://schema.org/median + */ + public function median($median) + { + return $this->setProperty('median', $median); + } + /** * The name of the item. * @@ -211,6 +155,62 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * The 10th percentile value. + * + * @param float|float[]|int|int[] $percentile10 + * + * @return static + * + * @see http://schema.org/percentile10 + */ + public function percentile10($percentile10) + { + return $this->setProperty('percentile10', $percentile10); + } + + /** + * The 25th percentile value. + * + * @param float|float[]|int|int[] $percentile25 + * + * @return static + * + * @see http://schema.org/percentile25 + */ + public function percentile25($percentile25) + { + return $this->setProperty('percentile25', $percentile25); + } + + /** + * The 75th percentile value. + * + * @param float|float[]|int|int[] $percentile75 + * + * @return static + * + * @see http://schema.org/percentile75 + */ + public function percentile75($percentile75) + { + return $this->setProperty('percentile75', $percentile75); + } + + /** + * The 90th percentile value. + * + * @param float|float[]|int|int[] $percentile90 + * + * @return static + * + * @see http://schema.org/percentile90 + */ + public function percentile90($percentile90) + { + return $this->setProperty('percentile90', $percentile90); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. diff --git a/src/Question.php b/src/Question.php index 401fa3999..b8daef610 100644 --- a/src/Question.php +++ b/src/Question.php @@ -15,92 +15,33 @@ class Question extends BaseType implements CreativeWorkContract, ThingContract { /** - * The answer(s) that has been accepted as best, typically on a - * Question/Answer site. Sites vary in their selection mechanisms, e.g. - * drawing on community opinion and/or the view of the Question author. - * - * @param Answer|Answer[]|ItemList|ItemList[] $acceptedAnswer - * - * @return static - * - * @see http://schema.org/acceptedAnswer - */ - public function acceptedAnswer($acceptedAnswer) - { - return $this->setProperty('acceptedAnswer', $acceptedAnswer); - } - - /** - * The number of answers this question has received. - * - * @param int|int[] $answerCount - * - * @return static - * - * @see http://schema.org/answerCount - */ - public function answerCount($answerCount) - { - return $this->setProperty('answerCount', $answerCount); - } - - /** - * The number of downvotes this question, answer or comment has received - * from the community. - * - * @param int|int[] $downvoteCount - * - * @return static - * - * @see http://schema.org/downvoteCount - */ - public function downvoteCount($downvoteCount) - { - return $this->setProperty('downvoteCount', $downvoteCount); - } - - /** - * An answer (possibly one of several, possibly incorrect) to a Question, - * e.g. on a Question/Answer site. - * - * @param Answer|Answer[]|ItemList|ItemList[] $suggestedAnswer - * - * @return static - * - * @see http://schema.org/suggestedAnswer - */ - public function suggestedAnswer($suggestedAnswer) - { - return $this->setProperty('suggestedAnswer', $suggestedAnswer); - } - - /** - * The number of upvotes this question, answer or comment has received from - * the community. + * The subject matter of the content. * - * @param int|int[] $upvoteCount + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/upvoteCount + * @see http://schema.org/about */ - public function upvoteCount($upvoteCount) + public function about($about) { - return $this->setProperty('upvoteCount', $upvoteCount); + return $this->setProperty('about', $about); } /** - * The subject matter of the content. + * The answer(s) that has been accepted as best, typically on a + * Question/Answer site. Sites vary in their selection mechanisms, e.g. + * drawing on community opinion and/or the view of the Question author. * - * @param Thing|Thing[] $about + * @param Answer|Answer[]|ItemList|ItemList[] $acceptedAnswer * * @return static * - * @see http://schema.org/about + * @see http://schema.org/acceptedAnswer */ - public function about($about) + public function acceptedAnswer($acceptedAnswer) { - return $this->setProperty('about', $about); + return $this->setProperty('acceptedAnswer', $acceptedAnswer); } /** @@ -233,6 +174,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -248,6 +208,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -262,6 +236,20 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The number of answers this question has received. + * + * @param int|int[] $answerCount + * + * @return static + * + * @see http://schema.org/answerCount + */ + public function answerCount($answerCount) + { + return $this->setProperty('answerCount', $answerCount); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -539,6 +527,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -553,6 +572,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The number of downvotes this question, answer or comment has received + * from the community. + * + * @param int|int[] $downvoteCount + * + * @return static + * + * @see http://schema.org/downvoteCount + */ + public function downvoteCount($downvoteCount) + { + return $this->setProperty('downvoteCount', $downvoteCount); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -764,6 +798,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -961,6 +1028,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -991,6 +1074,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1021,6 +1118,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1162,6 +1274,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1244,6 +1372,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * An answer (possibly one of several, possibly incorrect) to a Question, + * e.g. on a Question/Answer site. + * + * @param Answer|Answer[]|ItemList|ItemList[] $suggestedAnswer + * + * @return static + * + * @see http://schema.org/suggestedAnswer + */ + public function suggestedAnswer($suggestedAnswer) + { + return $this->setProperty('suggestedAnswer', $suggestedAnswer); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1366,232 +1523,75 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. + * The number of upvotes this question, answer or comment has received from + * the community. * - * @param string|string[] $name + * @param int|int[] $upvoteCount * * @return static * - * @see http://schema.org/name + * @see http://schema.org/upvoteCount */ - public function name($name) + public function upvoteCount($upvoteCount) { - return $this->setProperty('name', $name); + return $this->setProperty('upvoteCount', $upvoteCount); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The version of the CreativeWork embodied by a specified resource. * - * @param string|string[] $sameAs + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/version */ - public function sameAs($sameAs) + public function version($version) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('version', $version); } /** - * A CreativeWork or Event about this Thing. + * An embedded video object. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/video */ - public function subjectOf($subjectOf) + public function video($video) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('video', $video); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/QuoteAction.php b/src/QuoteAction.php index 2022df6f1..543ec0de0 100644 --- a/src/QuoteAction.php +++ b/src/QuoteAction.php @@ -16,107 +16,96 @@ class QuoteAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * Indicates the current disposition of the Action. * - * @param float|float[]|int|int[]|string|string[] $price + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/price + * @see http://schema.org/actionStatus */ - public function price($price) + public function actionStatus($actionStatus) { - return $this->setProperty('price', $price); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $priceCurrency + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/additionalType */ - public function priceCurrency($priceCurrency) + public function additionalType($additionalType) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('additionalType', $additionalType); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/agent */ - public function priceSpecification($priceSpecification) + public function agent($agent) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -157,288 +146,299 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/instrument */ - public function participant($participant) + public function instrument($instrument) { - return $this->setProperty('participant', $participant); + return $this->setProperty('instrument', $instrument); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Thing|Thing[] $result + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/result + * @see http://schema.org/location */ - public function result($result) + public function location($location) { - return $this->setProperty('result', $result); + return $this->setProperty('location', $location); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/mainEntityOfPage */ - public function startTime($startTime) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Indicates a target EntryPoint for an Action. + * The name of the item. * - * @param EntryPoint|EntryPoint[] $target + * @param string|string[] $name * * @return static * - * @see http://schema.org/target + * @see http://schema.org/name */ - public function target($target) + public function name($name) { - return $this->setProperty('target', $target); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/object */ - public function additionalType($additionalType) + public function object($object) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('object', $object); } /** - * An alias for the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/participant */ - public function alternateName($alternateName) + public function participant($participant) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('participant', $participant); } /** - * A description of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $description + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/description + * @see http://schema.org/potentialAction */ - public function description($description) + public function potentialAction($potentialAction) { - return $this->setProperty('description', $description); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $disambiguatingDescription + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/price */ - public function disambiguatingDescription($disambiguatingDescription) + public function price($price) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('price', $price); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceCurrency */ - public function identifier($identifier) + public function priceCurrency($priceCurrency) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceSpecification */ - public function image($image) + public function priceSpecification($priceSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/RVPark.php b/src/RVPark.php index 7f028df71..ca0dbee31 100644 --- a/src/RVPark.php +++ b/src/RVPark.php @@ -15,35 +15,6 @@ */ class RVPark extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/RadioChannel.php b/src/RadioChannel.php index d9d059559..1d5110064 100644 --- a/src/RadioChannel.php +++ b/src/RadioChannel.php @@ -15,6 +15,39 @@ */ class RadioChannel extends BaseType implements BroadcastChannelContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The unique address by which the BroadcastService can be identified in a * provider lineup. In US, this is typically a number. @@ -61,81 +94,6 @@ public function broadcastServiceTier($broadcastServiceTier) return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); } - /** - * Genre of the creative work, broadcast channel or group. - * - * @param string|string[] $genre - * - * @return static - * - * @see http://schema.org/genre - */ - public function genre($genre) - { - return $this->setProperty('genre', $genre); - } - - /** - * The CableOrSatelliteService offering the channel. - * - * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup - * - * @return static - * - * @see http://schema.org/inBroadcastLineup - */ - public function inBroadcastLineup($inBroadcastLineup) - { - return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); - } - - /** - * The BroadcastService offered on this channel. - * - * @param BroadcastService|BroadcastService[] $providesBroadcastService - * - * @return static - * - * @see http://schema.org/providesBroadcastService - */ - public function providesBroadcastService($providesBroadcastService) - { - return $this->setProperty('providesBroadcastService', $providesBroadcastService); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - /** * A description of the item. * @@ -167,6 +125,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -200,6 +172,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -245,6 +231,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + /** * 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 diff --git a/src/RadioClip.php b/src/RadioClip.php index 4dc21b08b..5b565976e 100644 --- a/src/RadioClip.php +++ b/src/RadioClip.php @@ -14,138 +14,6 @@ */ class RadioClip extends BaseType implements ClipContract, CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * Position of the clip within an ordered group of clips. - * - * @param int|int[]|string|string[] $clipNumber - * - * @return static - * - * @see http://schema.org/clipNumber - */ - public function clipNumber($clipNumber) - { - return $this->setProperty('clipNumber', $clipNumber); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The episode to which this clip belongs. - * - * @param Episode|Episode[] $partOfEpisode - * - * @return static - * - * @see http://schema.org/partOfEpisode - */ - public function partOfEpisode($partOfEpisode) - { - return $this->setProperty('partOfEpisode', $partOfEpisode); - } - - /** - * The season to which this episode belongs. - * - * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason - * - * @return static - * - * @see http://schema.org/partOfSeason - */ - public function partOfSeason($partOfSeason) - { - return $this->setProperty('partOfSeason', $partOfSeason); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - /** * The subject matter of the content. * @@ -290,6 +158,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -305,6 +223,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -435,6 +367,20 @@ public function citation($citation) return $this->setProperty('citation', $citation); } + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + /** * Comments, typically from users. * @@ -597,60 +543,122 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * 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. * - * @param string|string[] $educationalUse + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/disambiguatingDescription */ - public function educationalUse($educationalUse) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); } /** @@ -821,6 +829,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1018,6 +1059,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1048,6 +1105,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1064,6 +1149,48 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1078,6 +1205,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1219,6 +1361,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1301,6 +1459,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1422,6 +1594,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1465,190 +1651,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/RadioEpisode.php b/src/RadioEpisode.php index 84c375968..1acef7043 100644 --- a/src/RadioEpisode.php +++ b/src/RadioEpisode.php @@ -14,153 +14,6 @@ */ class RadioEpisode extends BaseType implements EpisodeContract, CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * Position of the episode within an ordered group of episodes. - * - * @param int|int[]|string|string[] $episodeNumber - * - * @return static - * - * @see http://schema.org/episodeNumber - */ - public function episodeNumber($episodeNumber) - { - return $this->setProperty('episodeNumber', $episodeNumber); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The season to which this episode belongs. - * - * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason - * - * @return static - * - * @see http://schema.org/partOfSeason - */ - public function partOfSeason($partOfSeason) - { - return $this->setProperty('partOfSeason', $partOfSeason); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The trailer of a movie or tv/radio series, season, episode, etc. - * - * @param VideoObject|VideoObject[] $trailer - * - * @return static - * - * @see http://schema.org/trailer - */ - public function trailer($trailer) - { - return $this->setProperty('trailer', $trailer); - } - /** * The subject matter of the content. * @@ -305,6 +158,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -320,6 +223,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -612,58 +529,120 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * 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. * - * @param string|string[] $educationalUse + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/disambiguatingDescription */ - public function educationalUse($educationalUse) + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) { return $this->setProperty('educationalUse', $educationalUse); } @@ -724,6 +703,20 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * Position of the episode within an ordered group of episodes. + * + * @param int|int[]|string|string[] $episodeNumber + * + * @return static + * + * @see http://schema.org/episodeNumber + */ + public function episodeNumber($episodeNumber) + { + return $this->setProperty('episodeNumber', $episodeNumber); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -836,6 +829,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1033,6 +1059,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1063,6 +1105,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1079,6 +1149,34 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1093,6 +1191,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1108,6 +1221,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1234,6 +1362,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1316,6 +1460,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1407,6 +1565,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1437,6 +1609,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1480,190 +1666,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/RadioSeason.php b/src/RadioSeason.php index 45dc61276..2a1943607 100644 --- a/src/RadioSeason.php +++ b/src/RadioSeason.php @@ -14,167 +14,6 @@ */ class RadioSeason extends BaseType implements CreativeWorkSeasonContract, CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * An episode of a tv, radio or game media within a series or season. - * - * @param Episode|Episode[] $episode - * - * @return static - * - * @see http://schema.org/episode - */ - public function episode($episode) - { - return $this->setProperty('episode', $episode); - } - - /** - * An episode of a TV/radio series or season. - * - * @param Episode|Episode[] $episodes - * - * @return static - * - * @see http://schema.org/episodes - */ - public function episodes($episodes) - { - return $this->setProperty('episodes', $episodes); - } - - /** - * The number of episodes in this season or series. - * - * @param int|int[] $numberOfEpisodes - * - * @return static - * - * @see http://schema.org/numberOfEpisodes - */ - public function numberOfEpisodes($numberOfEpisodes) - { - return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * Position of the season within an ordered group of seasons. - * - * @param int|int[]|string|string[] $seasonNumber - * - * @return static - * - * @see http://schema.org/seasonNumber - */ - public function seasonNumber($seasonNumber) - { - return $this->setProperty('seasonNumber', $seasonNumber); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - - /** - * The trailer of a movie or tv/radio series, season, episode, etc. - * - * @param VideoObject|VideoObject[] $trailer - * - * @return static - * - * @see http://schema.org/trailer - */ - public function trailer($trailer) - { - return $this->setProperty('trailer', $trailer); - } - /** * The subject matter of the content. * @@ -319,6 +158,41 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -334,6 +208,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -626,60 +514,107 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * 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. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/disambiguatingDescription */ - public function educationalAlignment($educationalAlignment) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * A link to the page containing the comments of the CreativeWork. * - * @param string|string[] $educationalUse + * @param string|string[] $discussionUrl * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/discussionUrl */ - public function educationalUse($educationalUse) + public function discussionUrl($discussionUrl) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); } /** @@ -738,6 +673,49 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An episode of a tv, radio or game media within a series or season. + * + * @param Episode|Episode[] $episode + * + * @return static + * + * @see http://schema.org/episode + */ + public function episode($episode) + { + return $this->setProperty('episode', $episode); + } + + /** + * An episode of a TV/radio series or season. + * + * @param Episode|Episode[] $episodes + * + * @return static + * + * @see http://schema.org/episodes + */ + public function episodes($episodes) + { + return $this->setProperty('episodes', $episodes); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -850,6 +828,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1047,6 +1058,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1077,6 +1104,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of episodes in this season or series. + * + * @param int|int[] $numberOfEpisodes + * + * @return static + * + * @see http://schema.org/numberOfEpisodes + */ + public function numberOfEpisodes($numberOfEpisodes) + { + return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1093,6 +1148,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1107,6 +1176,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1122,6 +1206,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1248,6 +1347,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1265,6 +1380,20 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * Position of the season within an ordered group of seasons. + * + * @param int|int[]|string|string[] $seasonNumber + * + * @return static + * + * @see http://schema.org/seasonNumber + */ + public function seasonNumber($seasonNumber) + { + return $this->setProperty('seasonNumber', $seasonNumber); + } + /** * The Organization on whose behalf the creator was working. * @@ -1330,6 +1459,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1421,6 +1579,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1451,6 +1623,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1494,190 +1680,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/RadioSeries.php b/src/RadioSeries.php index abcc822fe..857035c86 100644 --- a/src/RadioSeries.php +++ b/src/RadioSeries.php @@ -18,510 +18,325 @@ class RadioSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { /** - * 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. + * The subject matter of the content. * - * @param Person|Person[] $actor + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/actor + * @see http://schema.org/about */ - public function actor($actor) + public function about($about) { - return $this->setProperty('actor', $actor); + return $this->setProperty('about', $about); } /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. * - * @param Person|Person[] $actors + * @param string|string[] $accessMode * * @return static * - * @see http://schema.org/actors + * @see http://schema.org/accessMode */ - public function actors($actors) + public function accessMode($accessMode) { - return $this->setProperty('actors', $actors); + return $this->setProperty('accessMode', $accessMode); } /** - * A season that is part of the media series. + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. * - * @param CreativeWorkSeason|CreativeWorkSeason[] $containsSeason + * @param ItemList|ItemList[] $accessModeSufficient * * @return static * - * @see http://schema.org/containsSeason + * @see http://schema.org/accessModeSufficient */ - public function containsSeason($containsSeason) + public function accessModeSufficient($accessModeSufficient) { - return $this->setProperty('containsSeason', $containsSeason); + return $this->setProperty('accessModeSufficient', $accessModeSufficient); } /** - * 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. + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Person|Person[] $director + * @param string|string[] $accessibilityAPI * * @return static * - * @see http://schema.org/director + * @see http://schema.org/accessibilityAPI */ - public function director($director) + public function accessibilityAPI($accessibilityAPI) { - return $this->setProperty('director', $director); + return $this->setProperty('accessibilityAPI', $accessibilityAPI); } /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Person|Person[] $directors + * @param string|string[] $accessibilityControl * * @return static * - * @see http://schema.org/directors + * @see http://schema.org/accessibilityControl */ - public function directors($directors) + public function accessibilityControl($accessibilityControl) { - return $this->setProperty('directors', $directors); + return $this->setProperty('accessibilityControl', $accessibilityControl); } /** - * An episode of a tv, radio or game media within a series or season. + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Episode|Episode[] $episode + * @param string|string[] $accessibilityFeature * * @return static * - * @see http://schema.org/episode + * @see http://schema.org/accessibilityFeature */ - public function episode($episode) + public function accessibilityFeature($accessibilityFeature) { - return $this->setProperty('episode', $episode); + return $this->setProperty('accessibilityFeature', $accessibilityFeature); } /** - * An episode of a TV/radio series or season. + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Episode|Episode[] $episodes + * @param string|string[] $accessibilityHazard * * @return static * - * @see http://schema.org/episodes + * @see http://schema.org/accessibilityHazard */ - public function episodes($episodes) + public function accessibilityHazard($accessibilityHazard) { - return $this->setProperty('episodes', $episodes); + return $this->setProperty('accessibilityHazard', $accessibilityHazard); } /** - * The composer of the soundtrack. + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * @param string|string[] $accessibilitySummary * * @return static * - * @see http://schema.org/musicBy + * @see http://schema.org/accessibilitySummary */ - public function musicBy($musicBy) + public function accessibilitySummary($accessibilitySummary) { - return $this->setProperty('musicBy', $musicBy); + return $this->setProperty('accessibilitySummary', $accessibilitySummary); } /** - * The number of episodes in this season or series. + * Specifies the Person that is legally accountable for the CreativeWork. * - * @param int|int[] $numberOfEpisodes + * @param Person|Person[] $accountablePerson * * @return static * - * @see http://schema.org/numberOfEpisodes + * @see http://schema.org/accountablePerson */ - public function numberOfEpisodes($numberOfEpisodes) + public function accountablePerson($accountablePerson) { - return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + return $this->setProperty('accountablePerson', $accountablePerson); } /** - * The number of seasons in this series. + * 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. * - * @param int|int[] $numberOfSeasons + * @param Person|Person[] $actor * * @return static * - * @see http://schema.org/numberOfSeasons + * @see http://schema.org/actor */ - public function numberOfSeasons($numberOfSeasons) + public function actor($actor) { - return $this->setProperty('numberOfSeasons', $numberOfSeasons); + return $this->setProperty('actor', $actor); } /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. * - * @param Organization|Organization[] $productionCompany + * @param Person|Person[] $actors * * @return static * - * @see http://schema.org/productionCompany + * @see http://schema.org/actors */ - public function productionCompany($productionCompany) + public function actors($actors) { - return $this->setProperty('productionCompany', $productionCompany); + return $this->setProperty('actors', $actors); } /** - * A season in a media series. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param CreativeWorkSeason|CreativeWorkSeason[] $season + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/season + * @see http://schema.org/additionalType */ - public function season($season) + public function additionalType($additionalType) { - return $this->setProperty('season', $season); + return $this->setProperty('additionalType', $additionalType); } /** - * A season in a media series. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param CreativeWorkSeason|CreativeWorkSeason[] $seasons + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/seasons + * @see http://schema.org/aggregateRating */ - public function seasons($seasons) + public function aggregateRating($aggregateRating) { - return $this->setProperty('seasons', $seasons); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The trailer of a movie or tv/radio series, season, episode, etc. + * An alias for the item. * - * @param VideoObject|VideoObject[] $trailer + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/trailer + * @see http://schema.org/alternateName */ - public function trailer($trailer) + public function alternateName($alternateName) { - return $this->setProperty('trailer', $trailer); + return $this->setProperty('alternateName', $alternateName); } /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). + * A secondary title of the CreativeWork. * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * @param string|string[] $alternativeHeadline * * @return static * - * @see http://schema.org/endDate + * @see http://schema.org/alternativeHeadline */ - public function endDate($endDate) + public function alternativeHeadline($alternativeHeadline) { - return $this->setProperty('endDate', $endDate); + return $this->setProperty('alternativeHeadline', $alternativeHeadline); } /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. * - * @param string|string[] $issn + * @param MediaObject|MediaObject[] $associatedMedia * * @return static * - * @see http://schema.org/issn + * @see http://schema.org/associatedMedia */ - public function issn($issn) + public function associatedMedia($associatedMedia) { - return $this->setProperty('issn', $issn); + return $this->setProperty('associatedMedia', $associatedMedia); } /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). + * An intended audience, i.e. a group for whom something was created. * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/startDate + * @see http://schema.org/audience */ - public function startDate($startDate) + public function audience($audience) { - return $this->setProperty('startDate', $startDate); + return $this->setProperty('audience', $audience); } /** - * The subject matter of the content. + * An embedded audio object. * - * @param Thing|Thing[] $about + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio * * @return static * - * @see http://schema.org/about + * @see http://schema.org/audio */ - public function about($about) + public function audio($audio) { - return $this->setProperty('about', $about); + return $this->setProperty('audio', $audio); } /** - * The human sensory perceptual system or cognitive faculty through which a - * person may process or perceive information. Expected values include: - * auditory, tactile, textual, visual, colorDependent, chartOnVisual, - * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. * - * @param string|string[] $accessMode + * @param Organization|Organization[]|Person|Person[] $author * * @return static * - * @see http://schema.org/accessMode + * @see http://schema.org/author */ - public function accessMode($accessMode) + public function author($author) { - return $this->setProperty('accessMode', $accessMode); + return $this->setProperty('author', $author); } /** - * A list of single or combined accessModes that are sufficient to - * understand all the intellectual content of a resource. Expected values - * include: auditory, tactile, textual, visual. + * An award won by or for this item. * - * @param ItemList|ItemList[] $accessModeSufficient + * @param string|string[] $award * * @return static * - * @see http://schema.org/accessModeSufficient + * @see http://schema.org/award */ - public function accessModeSufficient($accessModeSufficient) + public function award($award) { - return $this->setProperty('accessModeSufficient', $accessModeSufficient); + return $this->setProperty('award', $award); } /** - * Indicates that the resource is compatible with the referenced - * accessibility API ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * Awards won by or for this item. * - * @param string|string[] $accessibilityAPI + * @param string|string[] $awards * * @return static * - * @see http://schema.org/accessibilityAPI + * @see http://schema.org/awards */ - public function accessibilityAPI($accessibilityAPI) - { - return $this->setProperty('accessibilityAPI', $accessibilityAPI); - } - - /** - * Identifies input methods that are sufficient to fully control the - * described resource ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). - * - * @param string|string[] $accessibilityControl - * - * @return static - * - * @see http://schema.org/accessibilityControl - */ - public function accessibilityControl($accessibilityControl) - { - return $this->setProperty('accessibilityControl', $accessibilityControl); - } - - /** - * Content features of the resource, such as accessible media, alternatives - * and supported enhancements for accessibility ([WebSchemas wiki lists - * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). - * - * @param string|string[] $accessibilityFeature - * - * @return static - * - * @see http://schema.org/accessibilityFeature - */ - public function accessibilityFeature($accessibilityFeature) - { - return $this->setProperty('accessibilityFeature', $accessibilityFeature); - } - - /** - * A characteristic of the described resource that is physiologically - * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas - * wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). - * - * @param string|string[] $accessibilityHazard - * - * @return static - * - * @see http://schema.org/accessibilityHazard - */ - public function accessibilityHazard($accessibilityHazard) - { - return $this->setProperty('accessibilityHazard', $accessibilityHazard); - } - - /** - * A human-readable summary of specific accessibility features or - * deficiencies, consistent with the other accessibility metadata but - * expressing subtleties such as "short descriptions are present but long - * descriptions will be needed for non-visual users" or "short descriptions - * are present and no long descriptions are needed." - * - * @param string|string[] $accessibilitySummary - * - * @return static - * - * @see http://schema.org/accessibilitySummary - */ - public function accessibilitySummary($accessibilitySummary) - { - return $this->setProperty('accessibilitySummary', $accessibilitySummary); - } - - /** - * Specifies the Person that is legally accountable for the CreativeWork. - * - * @param Person|Person[] $accountablePerson - * - * @return static - * - * @see http://schema.org/accountablePerson - */ - public function accountablePerson($accountablePerson) - { - return $this->setProperty('accountablePerson', $accountablePerson); - } - - /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. - * - * @param AggregateRating|AggregateRating[] $aggregateRating - * - * @return static - * - * @see http://schema.org/aggregateRating - */ - public function aggregateRating($aggregateRating) - { - return $this->setProperty('aggregateRating', $aggregateRating); - } - - /** - * A secondary title of the CreativeWork. - * - * @param string|string[] $alternativeHeadline - * - * @return static - * - * @see http://schema.org/alternativeHeadline - */ - public function alternativeHeadline($alternativeHeadline) - { - return $this->setProperty('alternativeHeadline', $alternativeHeadline); - } - - /** - * A media object that encodes this CreativeWork. This property is a synonym - * for encoding. - * - * @param MediaObject|MediaObject[] $associatedMedia - * - * @return static - * - * @see http://schema.org/associatedMedia - */ - public function associatedMedia($associatedMedia) - { - return $this->setProperty('associatedMedia', $associatedMedia); - } - - /** - * An intended audience, i.e. a group for whom something was created. - * - * @param Audience|Audience[] $audience - * - * @return static - * - * @see http://schema.org/audience - */ - public function audience($audience) - { - return $this->setProperty('audience', $audience); - } - - /** - * An embedded audio object. - * - * @param AudioObject|AudioObject[]|Clip|Clip[] $audio - * - * @return static - * - * @see http://schema.org/audio - */ - public function audio($audio) - { - return $this->setProperty('audio', $audio); - } - - /** - * The author of this content or rating. Please note that author is special - * in that HTML 5 provides a special mechanism for indicating authorship via - * the rel tag. That is equivalent to this and may be used interchangeably. - * - * @param Organization|Organization[]|Person|Person[] $author - * - * @return static - * - * @see http://schema.org/author - */ - public function author($author) - { - return $this->setProperty('author', $author); - } - - /** - * An award won by or for this item. - * - * @param string|string[] $award - * - * @return static - * - * @see http://schema.org/award - */ - public function award($award) - { - return $this->setProperty('award', $award); - } - - /** - * Awards won by or for this item. - * - * @param string|string[] $awards - * - * @return static - * - * @see http://schema.org/awards - */ - public function awards($awards) + public function awards($awards) { return $this->setProperty('awards', $awards); } @@ -585,6 +400,20 @@ public function commentCount($commentCount) return $this->setProperty('commentCount', $commentCount); } + /** + * A season that is part of the media series. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $containsSeason + * + * @return static + * + * @see http://schema.org/containsSeason + */ + public function containsSeason($containsSeason) + { + return $this->setProperty('containsSeason', $containsSeason); + } + /** * The location depicted or described in the content. For example, the * location in a photograph or painting. @@ -717,58 +546,120 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * 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. * - * @param string|string[] $educationalUse + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/disambiguatingDescription */ - public function educationalUse($educationalUse) + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) { return $this->setProperty('educationalUse', $educationalUse); } @@ -829,6 +720,49 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An episode of a tv, radio or game media within a series or season. + * + * @param Episode|Episode[] $episode + * + * @return static + * + * @see http://schema.org/episode + */ + public function episode($episode) + { + return $this->setProperty('episode', $episode); + } + + /** + * An episode of a TV/radio series or season. + * + * @param Episode|Episode[] $episodes + * + * @return static + * + * @see http://schema.org/episodes + */ + public function episodes($episodes) + { + return $this->setProperty('episodes', $episodes); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -941,6 +875,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1063,6 +1030,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1138,6 +1121,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1168,6 +1167,62 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of episodes in this season or series. + * + * @param int|int[] $numberOfEpisodes + * + * @return static + * + * @see http://schema.org/numberOfEpisodes + */ + public function numberOfEpisodes($numberOfEpisodes) + { + return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + } + + /** + * The number of seasons in this series. + * + * @param int|int[] $numberOfSeasons + * + * @return static + * + * @see http://schema.org/numberOfSeasons + */ + public function numberOfSeasons($numberOfSeasons) + { + return $this->setProperty('numberOfSeasons', $numberOfSeasons); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1198,6 +1253,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1213,6 +1283,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1340,11 +1425,27 @@ public function reviews($reviews) } /** - * Indicates (by URL or string) a particular version of a schema used in - * some CreativeWork. For example, a document could declare a schemaVersion - * using an URL such as http://schema.org/version/2.0/ if precise indication - * of schema version was required by some application. - * + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * * @param string|string[] $schemaVersion * * @return static @@ -1356,6 +1457,34 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A season in a media series. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $season + * + * @return static + * + * @see http://schema.org/season + */ + public function season($season) + { + return $this->setProperty('season', $season); + } + + /** + * A season in a media series. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $seasons + * + * @return static + * + * @see http://schema.org/seasons + */ + public function seasons($seasons) + { + return $this->setProperty('seasons', $seasons); + } + /** * The Organization on whose behalf the creator was working. * @@ -1421,6 +1550,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1512,6 +1670,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1542,6 +1714,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1585,206 +1771,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - } diff --git a/src/RadioStation.php b/src/RadioStation.php index 10817e806..387890540 100644 --- a/src/RadioStation.php +++ b/src/RadioStation.php @@ -16,126 +16,104 @@ class RadioStation extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Rating.php b/src/Rating.php index 0080d9e05..787c2960f 100644 --- a/src/Rating.php +++ b/src/Rating.php @@ -14,118 +14,67 @@ class Rating extends BaseType implements IntangibleContract, ThingContract { /** - * The author of this content or rating. Please note that author is special - * in that HTML 5 provides a special mechanism for indicating authorship via - * the rel tag. That is equivalent to this and may be used interchangeably. - * - * @param Organization|Organization[]|Person|Person[] $author - * - * @return static - * - * @see http://schema.org/author - */ - public function author($author) - { - return $this->setProperty('author', $author); - } - - /** - * The highest value allowed in this rating system. If bestRating is - * omitted, 5 is assumed. - * - * @param float|float[]|int|int[]|string|string[] $bestRating - * - * @return static - * - * @see http://schema.org/bestRating - */ - public function bestRating($bestRating) - { - return $this->setProperty('bestRating', $bestRating); - } - - /** - * The rating for the content. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param float|float[]|int|int[]|string|string[] $ratingValue - * - * @return static - * - * @see http://schema.org/ratingValue - */ - public function ratingValue($ratingValue) - { - return $this->setProperty('ratingValue', $ratingValue); - } - - /** - * This Review or Rating is relevant to this part or facet of the - * itemReviewed. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $reviewAspect + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/reviewAspect + * @see http://schema.org/additionalType */ - public function reviewAspect($reviewAspect) + public function additionalType($additionalType) { - return $this->setProperty('reviewAspect', $reviewAspect); + return $this->setProperty('additionalType', $additionalType); } /** - * The lowest value allowed in this rating system. If worstRating is - * omitted, 1 is assumed. + * An alias for the item. * - * @param float|float[]|int|int[]|string|string[] $worstRating + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/worstRating + * @see http://schema.org/alternateName */ - public function worstRating($worstRating) + public function alternateName($alternateName) { - return $this->setProperty('worstRating', $worstRating); + return $this->setProperty('alternateName', $alternateName); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $author * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/author */ - public function additionalType($additionalType) + public function author($author) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('author', $author); } /** - * An alias for the item. + * The highest value allowed in this rating system. If bestRating is + * omitted, 5 is assumed. * - * @param string|string[] $alternateName + * @param float|float[]|int|int[]|string|string[] $bestRating * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/bestRating */ - public function alternateName($alternateName) + public function bestRating($bestRating) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('bestRating', $bestRating); } /** @@ -237,6 +186,42 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The rating for the content. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param float|float[]|int|int[]|string|string[] $ratingValue + * + * @return static + * + * @see http://schema.org/ratingValue + */ + public function ratingValue($ratingValue) + { + return $this->setProperty('ratingValue', $ratingValue); + } + + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + /** * 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 @@ -281,4 +266,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The lowest value allowed in this rating system. If worstRating is + * omitted, 1 is assumed. + * + * @param float|float[]|int|int[]|string|string[] $worstRating + * + * @return static + * + * @see http://schema.org/worstRating + */ + public function worstRating($worstRating) + { + return $this->setProperty('worstRating', $worstRating); + } + } diff --git a/src/ReactAction.php b/src/ReactAction.php index 043cc364e..87db9f670 100644 --- a/src/ReactAction.php +++ b/src/ReactAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ReadAction.php b/src/ReadAction.php index 7f01d5cf4..7e75bf348 100644 --- a/src/ReadAction.php +++ b/src/ReadAction.php @@ -31,33 +31,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -76,325 +79,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/RealEstateAgent.php b/src/RealEstateAgent.php index 3305e100f..9c602764a 100644 --- a/src/RealEstateAgent.php +++ b/src/RealEstateAgent.php @@ -16,126 +16,104 @@ class RealEstateAgent extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ReceiveAction.php b/src/ReceiveAction.php index 23dee9d98..51a14a6b7 100644 --- a/src/ReceiveAction.php +++ b/src/ReceiveAction.php @@ -23,91 +23,110 @@ class ReceiveAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** - * A sub property of instrument. The method of delivery. + * Indicates the current disposition of the Action. * - * @param DeliveryMethod|DeliveryMethod[] $deliveryMethod + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/deliveryMethod + * @see http://schema.org/actionStatus */ - public function deliveryMethod($deliveryMethod) + public function actionStatus($actionStatus) { - return $this->setProperty('deliveryMethod', $deliveryMethod); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of participant. The participant who is at the sending end - * of the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Audience|Audience[]|Organization|Organization[]|Person|Person[] $sender + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/sender + * @see http://schema.org/additionalType */ - public function sender($sender) + public function additionalType($additionalType) { - return $this->setProperty('sender', $sender); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of location. The original location of the object or the - * agent before the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Place|Place[] $fromLocation + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/agent */ - public function fromLocation($fromLocation) + public function agent($agent) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('agent', $agent); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * An alias for the item. * - * @param Place|Place[] $toLocation + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/alternateName */ - public function toLocation($toLocation) + public function alternateName($alternateName) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A sub property of instrument. The method of delivery. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param DeliveryMethod|DeliveryMethod[] $deliveryMethod * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/deliveryMethod */ - public function actionStatus($actionStatus) + public function deliveryMethod($deliveryMethod) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('deliveryMethod', $deliveryMethod); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -148,288 +167,269 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/location + * @see http://schema.org/fromLocation */ - public function location($location) + public function fromLocation($fromLocation) { - return $this->setProperty('location', $location); + return $this->setProperty('fromLocation', $fromLocation); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $object + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/object + * @see http://schema.org/identifier */ - public function object($object) + public function identifier($identifier) { - return $this->setProperty('object', $object); + return $this->setProperty('identifier', $identifier); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/image */ - public function participant($participant) + public function image($image) { - return $this->setProperty('participant', $participant); + return $this->setProperty('image', $image); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/result */ - public function identifier($identifier) + public function result($result) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('result', $result); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A sub property of participant. The participant who is at the sending end + * of the action. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Audience|Audience[]|Organization|Organization[]|Person|Person[] $sender * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sender */ - public function mainEntityOfPage($mainEntityOfPage) + public function sender($sender) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sender', $sender); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/Recipe.php b/src/Recipe.php index c3d7cb491..4506612cfb 100644 --- a/src/Recipe.php +++ b/src/Recipe.php @@ -16,288 +16,6 @@ */ class Recipe extends BaseType implements HowToContract, CreativeWorkContract, ThingContract { - /** - * The time it takes to actually cook the dish, in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $cookTime - * - * @return static - * - * @see http://schema.org/cookTime - */ - public function cookTime($cookTime) - { - return $this->setProperty('cookTime', $cookTime); - } - - /** - * The method of cooking, such as Frying, Steaming, ... - * - * @param string|string[] $cookingMethod - * - * @return static - * - * @see http://schema.org/cookingMethod - */ - public function cookingMethod($cookingMethod) - { - return $this->setProperty('cookingMethod', $cookingMethod); - } - - /** - * A single ingredient used in the recipe, e.g. sugar, flour or garlic. - * - * @param string|string[] $ingredients - * - * @return static - * - * @see http://schema.org/ingredients - */ - public function ingredients($ingredients) - { - return $this->setProperty('ingredients', $ingredients); - } - - /** - * Nutrition information about the recipe or menu item. - * - * @param NutritionInformation|NutritionInformation[] $nutrition - * - * @return static - * - * @see http://schema.org/nutrition - */ - public function nutrition($nutrition) - { - return $this->setProperty('nutrition', $nutrition); - } - - /** - * The category of the recipe—for example, appetizer, entree, etc. - * - * @param string|string[] $recipeCategory - * - * @return static - * - * @see http://schema.org/recipeCategory - */ - public function recipeCategory($recipeCategory) - { - return $this->setProperty('recipeCategory', $recipeCategory); - } - - /** - * The cuisine of the recipe (for example, French or Ethiopian). - * - * @param string|string[] $recipeCuisine - * - * @return static - * - * @see http://schema.org/recipeCuisine - */ - public function recipeCuisine($recipeCuisine) - { - return $this->setProperty('recipeCuisine', $recipeCuisine); - } - - /** - * A single ingredient used in the recipe, e.g. sugar, flour or garlic. - * - * @param string|string[] $recipeIngredient - * - * @return static - * - * @see http://schema.org/recipeIngredient - */ - public function recipeIngredient($recipeIngredient) - { - return $this->setProperty('recipeIngredient', $recipeIngredient); - } - - /** - * A step in making the recipe, in the form of a single item (document, - * video, etc.) or an ordered list with HowToStep and/or HowToSection items. - * - * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $recipeInstructions - * - * @return static - * - * @see http://schema.org/recipeInstructions - */ - public function recipeInstructions($recipeInstructions) - { - return $this->setProperty('recipeInstructions', $recipeInstructions); - } - - /** - * The quantity produced by the recipe (for example, number of people - * served, number of servings, etc). - * - * @param QuantitativeValue|QuantitativeValue[]|string|string[] $recipeYield - * - * @return static - * - * @see http://schema.org/recipeYield - */ - public function recipeYield($recipeYield) - { - return $this->setProperty('recipeYield', $recipeYield); - } - - /** - * Indicates a dietary restriction or guideline for which this recipe or - * menu item is suitable, e.g. diabetic, halal etc. - * - * @param RestrictedDiet|RestrictedDiet[] $suitableForDiet - * - * @return static - * - * @see http://schema.org/suitableForDiet - */ - public function suitableForDiet($suitableForDiet) - { - return $this->setProperty('suitableForDiet', $suitableForDiet); - } - - /** - * The estimated cost of the supply or supplies consumed when performing - * instructions. - * - * @param MonetaryAmount|MonetaryAmount[]|string|string[] $estimatedCost - * - * @return static - * - * @see http://schema.org/estimatedCost - */ - public function estimatedCost($estimatedCost) - { - return $this->setProperty('estimatedCost', $estimatedCost); - } - - /** - * The length of time it takes to perform instructions or a direction (not - * including time to prepare the supplies), in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $performTime - * - * @return static - * - * @see http://schema.org/performTime - */ - public function performTime($performTime) - { - return $this->setProperty('performTime', $performTime); - } - - /** - * The length of time it takes to prepare the items to be used in - * instructions or a direction, in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $prepTime - * - * @return static - * - * @see http://schema.org/prepTime - */ - public function prepTime($prepTime) - { - return $this->setProperty('prepTime', $prepTime); - } - - /** - * A single step item (as HowToStep, text, document, video, etc.) or a - * HowToSection. - * - * @param CreativeWork|CreativeWork[]|HowToSection|HowToSection[]|HowToStep|HowToStep[]|string|string[] $step - * - * @return static - * - * @see http://schema.org/step - */ - public function step($step) - { - return $this->setProperty('step', $step); - } - - /** - * A single step item (as HowToStep, text, document, video, etc.) or a - * HowToSection (originally misnamed 'steps'; 'step' is preferred). - * - * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $steps - * - * @return static - * - * @see http://schema.org/steps - */ - public function steps($steps) - { - return $this->setProperty('steps', $steps); - } - - /** - * A sub-property of instrument. A supply consumed when performing - * instructions or a direction. - * - * @param HowToSupply|HowToSupply[]|string|string[] $supply - * - * @return static - * - * @see http://schema.org/supply - */ - public function supply($supply) - { - return $this->setProperty('supply', $supply); - } - - /** - * A sub property of instrument. An object used (but not consumed) when - * performing instructions or a direction. - * - * @param HowToTool|HowToTool[]|string|string[] $tool - * - * @return static - * - * @see http://schema.org/tool - */ - public function tool($tool) - { - return $this->setProperty('tool', $tool); - } - - /** - * The total time required to perform instructions or a direction (including - * time to prepare the supplies), in [ISO 8601 duration - * format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $totalTime - * - * @return static - * - * @see http://schema.org/totalTime - */ - public function totalTime($totalTime) - { - return $this->setProperty('totalTime', $totalTime); - } - - /** - * The quantity that results by performing instructions. For example, a - * paper airplane, 10 personalized candles. - * - * @param QuantitativeValue|QuantitativeValue[]|string|string[] $yield - * - * @return static - * - * @see http://schema.org/yield - */ - public function yield($yield) - { - return $this->setProperty('yield', $yield); - } - /** * The subject matter of the content. * @@ -442,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -457,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -660,6 +411,35 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * The time it takes to actually cook the dish, in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $cookTime + * + * @return static + * + * @see http://schema.org/cookTime + */ + public function cookTime($cookTime) + { + return $this->setProperty('cookTime', $cookTime); + } + + /** + * The method of cooking, such as Frying, Steaming, ... + * + * @param string|string[] $cookingMethod + * + * @return static + * + * @see http://schema.org/cookingMethod + */ + public function cookingMethod($cookingMethod) + { + return $this->setProperty('cookingMethod', $cookingMethod); + } + /** * The party holding the legal copyright to the CreativeWork. * @@ -748,6 +528,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -861,6 +672,21 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The estimated cost of the supply or supplies consumed when performing + * instructions. + * + * @param MonetaryAmount|MonetaryAmount[]|string|string[] $estimatedCost + * + * @return static + * + * @see http://schema.org/estimatedCost + */ + public function estimatedCost($estimatedCost) + { + return $this->setProperty('estimatedCost', $estimatedCost); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -973,21 +799,68 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * 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](http://tools.ietf.org/html/bcp47). See also * [[availableLanguage]]. * - * @param Language|Language[]|string|string[] $inLanguage + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * A single ingredient used in the recipe, e.g. sugar, flour or garlic. + * + * @param string|string[] $ingredients * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/ingredients */ - public function inLanguage($inLanguage) + public function ingredients($ingredients) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('ingredients', $ingredients); } /** @@ -1170,6 +1043,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1200,6 +1089,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Nutrition information about the recipe or menu item. + * + * @param NutritionInformation|NutritionInformation[] $nutrition + * + * @return static + * + * @see http://schema.org/nutrition + */ + public function nutrition($nutrition) + { + return $this->setProperty('nutrition', $nutrition); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1216,6 +1133,22 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The length of time it takes to perform instructions or a direction (not + * including time to prepare the supplies), in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $performTime + * + * @return static + * + * @see http://schema.org/performTime + */ + public function performTime($performTime) + { + return $this->setProperty('performTime', $performTime); + } + /** * The position of an item in a series or sequence of items. * @@ -1230,6 +1163,37 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * The length of time it takes to prepare the items to be used in + * instructions or a direction, in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $prepTime + * + * @return static + * + * @see http://schema.org/prepTime + */ + public function prepTime($prepTime) + { + return $this->setProperty('prepTime', $prepTime); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1313,6 +1277,78 @@ public function publishingPrinciples($publishingPrinciples) return $this->setProperty('publishingPrinciples', $publishingPrinciples); } + /** + * The category of the recipe—for example, appetizer, entree, etc. + * + * @param string|string[] $recipeCategory + * + * @return static + * + * @see http://schema.org/recipeCategory + */ + public function recipeCategory($recipeCategory) + { + return $this->setProperty('recipeCategory', $recipeCategory); + } + + /** + * The cuisine of the recipe (for example, French or Ethiopian). + * + * @param string|string[] $recipeCuisine + * + * @return static + * + * @see http://schema.org/recipeCuisine + */ + public function recipeCuisine($recipeCuisine) + { + return $this->setProperty('recipeCuisine', $recipeCuisine); + } + + /** + * A single ingredient used in the recipe, e.g. sugar, flour or garlic. + * + * @param string|string[] $recipeIngredient + * + * @return static + * + * @see http://schema.org/recipeIngredient + */ + public function recipeIngredient($recipeIngredient) + { + return $this->setProperty('recipeIngredient', $recipeIngredient); + } + + /** + * A step in making the recipe, in the form of a single item (document, + * video, etc.) or an ordered list with HowToStep and/or HowToSection items. + * + * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $recipeInstructions + * + * @return static + * + * @see http://schema.org/recipeInstructions + */ + public function recipeInstructions($recipeInstructions) + { + return $this->setProperty('recipeInstructions', $recipeInstructions); + } + + /** + * The quantity produced by the recipe (for example, number of people + * served, number of servings, etc). + * + * @param QuantitativeValue|QuantitativeValue[]|string|string[] $recipeYield + * + * @return static + * + * @see http://schema.org/recipeYield + */ + public function recipeYield($recipeYield) + { + return $this->setProperty('recipeYield', $recipeYield); + } + /** * The Event where the CreativeWork was recorded. The CreativeWork may * capture all or part of the event. @@ -1371,6 +1407,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1426,31 +1478,105 @@ public function spatial($spatial) * areas that the dataset describes: a dataset of New York weather * would have spatialCoverage which was the place: the state of New York. * - * @param Place|Place[] $spatialCoverage + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * A single step item (as HowToStep, text, document, video, etc.) or a + * HowToSection. + * + * @param CreativeWork|CreativeWork[]|HowToSection|HowToSection[]|HowToStep|HowToStep[]|string|string[] $step + * + * @return static + * + * @see http://schema.org/step + */ + public function step($step) + { + return $this->setProperty('step', $step); + } + + /** + * A single step item (as HowToStep, text, document, video, etc.) or a + * HowToSection (originally misnamed 'steps'; 'step' is preferred). + * + * @param CreativeWork|CreativeWork[]|ItemList|ItemList[]|string|string[] $steps + * + * @return static + * + * @see http://schema.org/steps + */ + public function steps($steps) + { + return $this->setProperty('steps', $steps); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Indicates a dietary restriction or guideline for which this recipe or + * menu item is suitable, e.g. diabetic, halal etc. + * + * @param RestrictedDiet|RestrictedDiet[] $suitableForDiet * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/suitableForDiet */ - public function spatialCoverage($spatialCoverage) + public function suitableForDiet($suitableForDiet) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('suitableForDiet', $suitableForDiet); } /** - * 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. + * A sub-property of instrument. A supply consumed when performing + * instructions or a direction. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param HowToSupply|HowToSupply[]|string|string[] $supply * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/supply */ - public function sponsor($sponsor) + public function supply($supply) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('supply', $supply); } /** @@ -1544,6 +1670,37 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * A sub property of instrument. An object used (but not consumed) when + * performing instructions or a direction. + * + * @param HowToTool|HowToTool[]|string|string[] $tool + * + * @return static + * + * @see http://schema.org/tool + */ + public function tool($tool) + { + return $this->setProperty('tool', $tool); + } + + /** + * The total time required to perform instructions or a direction (including + * time to prepare the supplies), in [ISO 8601 duration + * format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $totalTime + * + * @return static + * + * @see http://schema.org/totalTime + */ + public function totalTime($totalTime) + { + return $this->setProperty('totalTime', $totalTime); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1574,6 +1731,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1618,189 +1789,18 @@ public function workExample($workExample) } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. + * The quantity that results by performing instructions. For example, a + * paper airplane, 10 personalized candles. * - * @param string|string[] $url + * @param QuantitativeValue|QuantitativeValue[]|string|string[] $yield * * @return static * - * @see http://schema.org/url + * @see http://schema.org/yield */ - public function url($url) + public function yield($yield) { - return $this->setProperty('url', $url); + return $this->setProperty('yield', $yield); } } diff --git a/src/RecyclingCenter.php b/src/RecyclingCenter.php index 0784ee76e..132fb6370 100644 --- a/src/RecyclingCenter.php +++ b/src/RecyclingCenter.php @@ -16,126 +16,104 @@ class RecyclingCenter extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/RegisterAction.php b/src/RegisterAction.php index e20301823..4763fa40b 100644 --- a/src/RegisterAction.php +++ b/src/RegisterAction.php @@ -38,340 +38,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/RejectAction.php b/src/RejectAction.php index e108ca459..8455909a6 100644 --- a/src/RejectAction.php +++ b/src/RejectAction.php @@ -34,340 +34,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/RentAction.php b/src/RentAction.php index f9ee9644f..7c20b5799 100644 --- a/src/RentAction.php +++ b/src/RentAction.php @@ -17,136 +17,96 @@ class RentAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The owner of the real estate property. - * - * @param Organization|Organization[]|Person|Person[] $landlord - * - * @return static - * - * @see http://schema.org/landlord - */ - public function landlord($landlord) - { - return $this->setProperty('landlord', $landlord); - } - - /** - * A sub property of participant. The real estate agent involved in the - * action. + * Indicates the current disposition of the Action. * - * @param RealEstateAgent|RealEstateAgent[] $realEstateAgent + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/realEstateAgent + * @see http://schema.org/actionStatus */ - public function realEstateAgent($realEstateAgent) + public function actionStatus($actionStatus) { - return $this->setProperty('realEstateAgent', $realEstateAgent); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param float|float[]|int|int[]|string|string[] $price + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/price + * @see http://schema.org/additionalType */ - public function price($price) + public function additionalType($additionalType) { - return $this->setProperty('price', $price); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param string|string[] $priceCurrency + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/agent */ - public function priceCurrency($priceCurrency) + public function agent($agent) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('agent', $agent); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * An alias for the item. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/alternateName */ - public function priceSpecification($priceSpecification) + public function alternateName($alternateName) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -187,274 +147,300 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $instrument + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/identifier */ - public function instrument($instrument) + public function identifier($identifier) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/object + * @see http://schema.org/instrument */ - public function object($object) + public function instrument($instrument) { - return $this->setProperty('object', $object); + return $this->setProperty('instrument', $instrument); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * A sub property of participant. The owner of the real estate property. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Organization|Organization[]|Person|Person[] $landlord * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/landlord */ - public function participant($participant) + public function landlord($landlord) { - return $this->setProperty('participant', $participant); + return $this->setProperty('landlord', $landlord); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Thing|Thing[] $result + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/result + * @see http://schema.org/location */ - public function result($result) + public function location($location) { - return $this->setProperty('result', $result); + return $this->setProperty('location', $location); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/mainEntityOfPage */ - public function startTime($startTime) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Indicates a target EntryPoint for an Action. + * The name of the item. * - * @param EntryPoint|EntryPoint[] $target + * @param string|string[] $name * * @return static * - * @see http://schema.org/target + * @see http://schema.org/name */ - public function target($target) + public function name($name) { - return $this->setProperty('target', $target); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/object */ - public function additionalType($additionalType) + public function object($object) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('object', $object); } /** - * An alias for the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/participant */ - public function alternateName($alternateName) + public function participant($participant) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('participant', $participant); } /** - * A description of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $description + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/description + * @see http://schema.org/potentialAction */ - public function description($description) + public function potentialAction($potentialAction) { - return $this->setProperty('description', $description); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $disambiguatingDescription + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/price */ - public function disambiguatingDescription($disambiguatingDescription) + public function price($price) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('price', $price); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceCurrency */ - public function identifier($identifier) + public function priceCurrency($priceCurrency) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceSpecification */ - public function image($image) + public function priceSpecification($priceSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A sub property of participant. The real estate agent involved in the + * action. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param RealEstateAgent|RealEstateAgent[] $realEstateAgent * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/realEstateAgent */ - public function mainEntityOfPage($mainEntityOfPage) + public function realEstateAgent($realEstateAgent) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('realEstateAgent', $realEstateAgent); } /** - * The name of the item. + * The result produced in the action. e.g. John wrote *a book*. * - * @param string|string[] $name + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/name + * @see http://schema.org/result */ - public function name($name) + public function result($result) { - return $this->setProperty('name', $name); + return $this->setProperty('result', $result); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * 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. * - * @param Action|Action[] $potentialAction + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/sameAs */ - public function potentialAction($potentialAction) + public function sameAs($sameAs) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('sameAs', $sameAs); } /** - * 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. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/startTime */ - public function sameAs($sameAs) + public function startTime($startTime) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('startTime', $startTime); } /** @@ -471,6 +457,20 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + /** * URL of the item. * diff --git a/src/RentalCarReservation.php b/src/RentalCarReservation.php index ef94f1f84..5e0897181 100644 --- a/src/RentalCarReservation.php +++ b/src/RentalCarReservation.php @@ -19,59 +19,36 @@ class RentalCarReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** - * Where a rental car can be dropped off. - * - * @param Place|Place[] $dropoffLocation - * - * @return static - * - * @see http://schema.org/dropoffLocation - */ - public function dropoffLocation($dropoffLocation) - { - return $this->setProperty('dropoffLocation', $dropoffLocation); - } - - /** - * When a rental car can be dropped off. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dropoffTime - * - * @return static - * - * @see http://schema.org/dropoffTime - */ - public function dropoffTime($dropoffTime) - { - return $this->setProperty('dropoffTime', $dropoffTime); - } - - /** - * Where a taxi will pick up a passenger or a rental car can be picked up. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $pickupLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/pickupLocation + * @see http://schema.org/additionalType */ - public function pickupLocation($pickupLocation) + public function additionalType($additionalType) { - return $this->setProperty('pickupLocation', $pickupLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * When a taxi will pickup a passenger or a rental car can be picked up. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $pickupTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/pickupTime + * @see http://schema.org/alternateName */ - public function pickupTime($pickupTime) + public function alternateName($alternateName) { - return $this->setProperty('pickupTime', $pickupTime); + return $this->setProperty('alternateName', $alternateName); } /** @@ -121,305 +98,292 @@ public function broker($broker) } /** - * The date and time the reservation was modified. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/description */ - public function modifiedTime($modifiedTime) + public function description($description) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('description', $description); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. * - * @param string|string[] $priceCurrency + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/disambiguatingDescription */ - public function priceCurrency($priceCurrency) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * Where a rental car can be dropped off. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param Place|Place[] $dropoffLocation * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/dropoffLocation */ - public function programMembershipUsed($programMembershipUsed) + public function dropoffLocation($dropoffLocation) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('dropoffLocation', $dropoffLocation); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * When a rental car can be dropped off. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param \DateTimeInterface|\DateTimeInterface[] $dropoffTime * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/dropoffTime */ - public function provider($provider) + public function dropoffTime($dropoffTime) { - return $this->setProperty('provider', $provider); + return $this->setProperty('dropoffTime', $dropoffTime); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $reservationFor + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/identifier */ - public function reservationFor($reservationFor) + public function identifier($identifier) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('identifier', $identifier); } /** - * A unique identifier for the reservation. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $reservationId + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/image */ - public function reservationId($reservationId) + public function image($image) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('image', $image); } /** - * The current status of the reservation. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/mainEntityOfPage */ - public function reservationStatus($reservationStatus) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A ticket associated with the reservation. + * The date and time the reservation was modified. * - * @param Ticket|Ticket[] $reservedTicket + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/modifiedTime */ - public function reservedTicket($reservedTicket) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. + * The name of the item. * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * @param string|string[] $name * * @return static * - * @see http://schema.org/totalPrice + * @see http://schema.org/name */ - public function totalPrice($totalPrice) + public function name($name) { - return $this->setProperty('totalPrice', $totalPrice); + return $this->setProperty('name', $name); } /** - * The person or organization the reservation or ticket is for. + * Where a taxi will pick up a passenger or a rental car can be picked up. * - * @param Organization|Organization[]|Person|Person[] $underName + * @param Place|Place[] $pickupLocation * * @return static * - * @see http://schema.org/underName + * @see http://schema.org/pickupLocation */ - public function underName($underName) + public function pickupLocation($pickupLocation) { - return $this->setProperty('underName', $underName); + return $this->setProperty('pickupLocation', $pickupLocation); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * When a taxi will pickup a passenger or a rental car can be picked up. * - * @param string|string[] $additionalType + * @param \DateTimeInterface|\DateTimeInterface[] $pickupTime * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/pickupTime */ - public function additionalType($additionalType) + public function pickupTime($pickupTime) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('pickupTime', $pickupTime); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $description + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/description + * @see http://schema.org/priceCurrency */ - public function description($description) + public function priceCurrency($priceCurrency) { - return $this->setProperty('description', $description); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * 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. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $disambiguatingDescription + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/programMembershipUsed */ - public function disambiguatingDescription($disambiguatingDescription) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/provider */ - public function identifier($identifier) + public function provider($provider) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('provider', $provider); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservationFor */ - public function image($image) + public function reservationFor($reservationFor) { - return $this->setProperty('image', $image); + return $this->setProperty('reservationFor', $reservationFor); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A unique identifier for the reservation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/reservationId */ - public function mainEntityOfPage($mainEntityOfPage) + public function reservationId($reservationId) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('reservationId', $reservationId); } /** - * The name of the item. + * The current status of the reservation. * - * @param string|string[] $name + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/name + * @see http://schema.org/reservationStatus */ - public function name($name) + public function reservationStatus($reservationStatus) { - return $this->setProperty('name', $name); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A ticket associated with the reservation. * - * @param Action|Action[] $potentialAction + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/reservedTicket */ - public function potentialAction($potentialAction) + public function reservedTicket($reservedTicket) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('reservedTicket', $reservedTicket); } /** @@ -452,6 +416,42 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + /** * URL of the item. * diff --git a/src/ReplaceAction.php b/src/ReplaceAction.php index 485769a57..44715e079 100644 --- a/src/ReplaceAction.php +++ b/src/ReplaceAction.php @@ -15,88 +15,110 @@ class ReplaceAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract { /** - * A sub property of object. The object that is being replaced. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $replacee + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/replacee + * @see http://schema.org/actionStatus */ - public function replacee($replacee) + public function actionStatus($actionStatus) { - return $this->setProperty('replacee', $replacee); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of object. The object that replaces. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $replacer + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/replacer + * @see http://schema.org/additionalType */ - public function replacer($replacer) + public function additionalType($additionalType) { - return $this->setProperty('replacer', $replacer); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of object. The collection target of the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Thing|Thing[] $collection + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/collection + * @see http://schema.org/agent */ - public function collection($collection) + public function agent($agent) { - return $this->setProperty('collection', $collection); + return $this->setProperty('agent', $agent); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); } /** * A sub property of object. The collection target of the action. * - * @param Thing|Thing[] $targetCollection + * @param Thing|Thing[] $collection * * @return static * - * @see http://schema.org/targetCollection + * @see http://schema.org/collection */ - public function targetCollection($targetCollection) + public function collection($collection) { - return $this->setProperty('targetCollection', $targetCollection); + return $this->setProperty('collection', $collection); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -137,288 +159,266 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/instrument */ - public function participant($participant) + public function instrument($instrument) { - return $this->setProperty('participant', $participant); + return $this->setProperty('instrument', $instrument); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Thing|Thing[] $result + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/result + * @see http://schema.org/location */ - public function result($result) + public function location($location) { - return $this->setProperty('result', $result); + return $this->setProperty('location', $location); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/mainEntityOfPage */ - public function startTime($startTime) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Indicates a target EntryPoint for an Action. + * The name of the item. * - * @param EntryPoint|EntryPoint[] $target + * @param string|string[] $name * * @return static * - * @see http://schema.org/target + * @see http://schema.org/name */ - public function target($target) + public function name($name) { - return $this->setProperty('target', $target); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/object */ - public function additionalType($additionalType) + public function object($object) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('object', $object); } /** - * An alias for the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/participant */ - public function alternateName($alternateName) + public function participant($participant) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('participant', $participant); } /** - * A description of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $description + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/description + * @see http://schema.org/potentialAction */ - public function description($description) + public function potentialAction($potentialAction) { - return $this->setProperty('description', $description); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. + * A sub property of object. The object that is being replaced. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $replacee * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/replacee */ - public function disambiguatingDescription($disambiguatingDescription) + public function replacee($replacee) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('replacee', $replacee); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of object. The object that replaces. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Thing|Thing[] $replacer * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/replacer */ - public function identifier($identifier) + public function replacer($replacer) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('replacer', $replacer); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of object. The collection target of the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Thing|Thing[] $targetCollection * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/targetCollection */ - public function subjectOf($subjectOf) + public function targetCollection($targetCollection) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('targetCollection', $targetCollection); } /** diff --git a/src/ReplyAction.php b/src/ReplyAction.php index ed63de833..0b2e63190 100644 --- a/src/ReplyAction.php +++ b/src/ReplyAction.php @@ -21,107 +21,110 @@ class ReplyAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** - * A sub property of result. The Comment created or sent as a result of this - * action. + * The subject matter of the content. * - * @param Comment|Comment[] $resultComment + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/resultComment + * @see http://schema.org/about */ - public function resultComment($resultComment) + public function about($about) { - return $this->setProperty('resultComment', $resultComment); + return $this->setProperty('about', $about); } /** - * The subject matter of the content. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $about + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/about + * @see http://schema.org/actionStatus */ - public function about($about) + public function actionStatus($actionStatus) { - return $this->setProperty('about', $about); + return $this->setProperty('actionStatus', $actionStatus); } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[]|string|string[] $inLanguage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/additionalType */ - public function inLanguage($inLanguage) + public function additionalType($additionalType) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of instrument. The language used on this action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Language|Language[] $language + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/language + * @see http://schema.org/agent */ - public function language($language) + public function agent($agent) { - return $this->setProperty('language', $language); + return $this->setProperty('agent', $agent); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * An alias for the item. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/alternateName */ - public function recipient($recipient) + public function alternateName($alternateName) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -162,288 +165,285 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $instrument + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/identifier */ - public function instrument($instrument) + public function identifier($identifier) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Thing|Thing[] $object + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/object + * @see http://schema.org/inLanguage */ - public function object($object) + public function inLanguage($inLanguage) { - return $this->setProperty('object', $object); + return $this->setProperty('inLanguage', $inLanguage); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/instrument */ - public function participant($participant) + public function instrument($instrument) { - return $this->setProperty('participant', $participant); + return $this->setProperty('instrument', $instrument); } /** - * The result produced in the action. e.g. John wrote *a book*. + * A sub property of instrument. The language used on this action. * - * @param Thing|Thing[] $result + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/result + * @see http://schema.org/language */ - public function result($result) + public function language($language) { - return $this->setProperty('result', $result); + return $this->setProperty('language', $language); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/recipient */ - public function identifier($identifier) + public function recipient($recipient) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('recipient', $recipient); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A sub property of result. The Comment created or sent as a result of this + * action. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Comment|Comment[] $resultComment * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/resultComment */ - public function mainEntityOfPage($mainEntityOfPage) + public function resultComment($resultComment) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('resultComment', $resultComment); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Report.php b/src/Report.php index 5edbbd875..8033fe78b 100644 --- a/src/Report.php +++ b/src/Report.php @@ -14,146 +14,6 @@ */ class Report extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { - /** - * The number or other unique designator assigned to a Report by the - * publishing organization. - * - * @param string|string[] $reportNumber - * - * @return static - * - * @see http://schema.org/reportNumber - */ - public function reportNumber($reportNumber) - { - return $this->setProperty('reportNumber', $reportNumber); - } - - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -298,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -313,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -327,6 +220,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -604,6 +526,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -830,28 +783,61 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Language|Language[]|string|string[] $inLanguage + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/identifier */ - public function inLanguage($inLanguage) + public function identifier($identifier) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('identifier', $identifier); } /** - * The number of interactions for the CreativeWork using the WebSite or - * SoftwareApplication. The most specific child type of InteractionCounter - * should be used. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic * * @return static * @@ -1026,6 +1012,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1056,6 +1058,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1072,6 +1088,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1086,6 +1145,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1199,6 +1273,21 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * The number or other unique designator assigned to a Report by the + * publishing organization. + * + * @param string|string[] $reportNumber + * + * @return static + * + * @see http://schema.org/reportNumber + */ + public function reportNumber($reportNumber) + { + return $this->setProperty('reportNumber', $reportNumber); + } + /** * A review of the item. * @@ -1227,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1293,6 +1398,45 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + /** * 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 @@ -1309,6 +1453,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1430,6 +1588,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1459,204 +1631,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/Reservation.php b/src/Reservation.php index d8b65a7c4..4997b3d12 100644 --- a/src/Reservation.php +++ b/src/Reservation.php @@ -19,6 +19,39 @@ */ class Reservation extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as * a booking agent. @@ -66,335 +99,302 @@ public function broker($broker) } /** - * The date and time the reservation was modified. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/description */ - public function modifiedTime($modifiedTime) + public function description($description) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('description', $description); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. * - * @param string|string[] $priceCurrency + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/disambiguatingDescription */ - public function priceCurrency($priceCurrency) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/identifier */ - public function programMembershipUsed($programMembershipUsed) + public function identifier($identifier) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('identifier', $identifier); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/image */ - public function provider($provider) + public function image($image) { - return $this->setProperty('provider', $provider); + return $this->setProperty('image', $image); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $reservationFor + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/mainEntityOfPage */ - public function reservationFor($reservationFor) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A unique identifier for the reservation. + * The date and time the reservation was modified. * - * @param string|string[] $reservationId + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/modifiedTime */ - public function reservationId($reservationId) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The current status of the reservation. + * The name of the item. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/name */ - public function reservationStatus($reservationStatus) + public function name($name) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('name', $name); } /** - * A ticket associated with the reservation. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Ticket|Ticket[] $reservedTicket + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/potentialAction */ - public function reservedTicket($reservedTicket) + public function potentialAction($potentialAction) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice - * - * @return static - * - * @see http://schema.org/totalPrice - */ - public function totalPrice($totalPrice) - { - return $this->setProperty('totalPrice', $totalPrice); - } - - /** - * The person or organization the reservation or ticket is for. - * - * @param Organization|Organization[]|Person|Person[] $underName - * - * @return static - * - * @see http://schema.org/underName - */ - public function underName($underName) - { - return $this->setProperty('underName', $underName); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $additionalType + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/priceCurrency */ - public function additionalType($additionalType) + public function priceCurrency($priceCurrency) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An alias for the item. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $alternateName + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/programMembershipUsed */ - public function alternateName($alternateName) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * A description of the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/description + * @see http://schema.org/provider */ - public function description($description) + public function provider($provider) { - return $this->setProperty('description', $description); + return $this->setProperty('provider', $provider); } /** - * 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. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/reservationFor */ - public function disambiguatingDescription($disambiguatingDescription) + public function reservationFor($reservationFor) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('reservationFor', $reservationFor); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A unique identifier for the reservation. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reservationId */ - public function identifier($identifier) + public function reservationId($reservationId) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reservationId', $reservationId); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The current status of the reservation. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservationStatus */ - public function image($image) + public function reservationStatus($reservationStatus) { - return $this->setProperty('image', $image); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A ticket associated with the reservation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/reservedTicket */ - public function mainEntityOfPage($mainEntityOfPage) + public function reservedTicket($reservedTicket) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('reservedTicket', $reservedTicket); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param string|string[] $sameAs + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/totalPrice */ - public function sameAs($sameAs) + public function totalPrice($totalPrice) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('totalPrice', $totalPrice); } /** - * A CreativeWork or Event about this Thing. + * The person or organization the reservation or ticket is for. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Organization|Organization[]|Person|Person[] $underName * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/underName */ - public function subjectOf($subjectOf) + public function underName($underName) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('underName', $underName); } /** diff --git a/src/ReservationPackage.php b/src/ReservationPackage.php index 1798d1e86..097f4fb8e 100644 --- a/src/ReservationPackage.php +++ b/src/ReservationPackage.php @@ -15,32 +15,50 @@ class ReservationPackage extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** - * The airline-specific indicator of boarding order / preference. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $boardingGroup + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/boardingGroup + * @see http://schema.org/additionalType */ - public function boardingGroup($boardingGroup) + public function additionalType($additionalType) { - return $this->setProperty('boardingGroup', $boardingGroup); + return $this->setProperty('additionalType', $additionalType); } /** - * The individual reservations included in the package. Typically a repeated - * property. + * An alias for the item. * - * @param Reservation|Reservation[] $subReservation + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/subReservation + * @see http://schema.org/alternateName */ - public function subReservation($subReservation) + public function alternateName($alternateName) { - return $this->setProperty('subReservation', $subReservation); + return $this->setProperty('alternateName', $alternateName); + } + + /** + * The airline-specific indicator of boarding order / preference. + * + * @param string|string[] $boardingGroup + * + * @return static + * + * @see http://schema.org/boardingGroup + */ + public function boardingGroup($boardingGroup) + { + return $this->setProperty('boardingGroup', $boardingGroup); } /** @@ -90,335 +108,317 @@ public function broker($broker) } /** - * The date and time the reservation was modified. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/description */ - public function modifiedTime($modifiedTime) + public function description($description) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('description', $description); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. * - * @param string|string[] $priceCurrency + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/disambiguatingDescription */ - public function priceCurrency($priceCurrency) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/identifier */ - public function programMembershipUsed($programMembershipUsed) + public function identifier($identifier) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('identifier', $identifier); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/image */ - public function provider($provider) + public function image($image) { - return $this->setProperty('provider', $provider); + return $this->setProperty('image', $image); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $reservationFor + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/mainEntityOfPage */ - public function reservationFor($reservationFor) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A unique identifier for the reservation. + * The date and time the reservation was modified. * - * @param string|string[] $reservationId + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/modifiedTime */ - public function reservationId($reservationId) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The current status of the reservation. + * The name of the item. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/name */ - public function reservationStatus($reservationStatus) + public function name($name) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('name', $name); } /** - * A ticket associated with the reservation. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Ticket|Ticket[] $reservedTicket + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/potentialAction */ - public function reservedTicket($reservedTicket) + public function potentialAction($potentialAction) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice - * - * @return static - * - * @see http://schema.org/totalPrice - */ - public function totalPrice($totalPrice) - { - return $this->setProperty('totalPrice', $totalPrice); - } - - /** - * The person or organization the reservation or ticket is for. + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Organization|Organization[]|Person|Person[] $underName + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/underName + * @see http://schema.org/priceCurrency */ - public function underName($underName) + public function priceCurrency($priceCurrency) { - return $this->setProperty('underName', $underName); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $additionalType + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/programMembershipUsed */ - public function additionalType($additionalType) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * An alias for the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/provider */ - public function alternateName($alternateName) + public function provider($provider) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('provider', $provider); } /** - * A description of the item. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param string|string[] $description + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/description + * @see http://schema.org/reservationFor */ - public function description($description) + public function reservationFor($reservationFor) { - return $this->setProperty('description', $description); + return $this->setProperty('reservationFor', $reservationFor); } /** - * 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. + * A unique identifier for the reservation. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/reservationId */ - public function disambiguatingDescription($disambiguatingDescription) + public function reservationId($reservationId) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('reservationId', $reservationId); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The current status of the reservation. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reservationStatus */ - public function identifier($identifier) + public function reservationStatus($reservationStatus) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A ticket associated with the reservation. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservedTicket */ - public function image($image) + public function reservedTicket($reservedTicket) { - return $this->setProperty('image', $image); + return $this->setProperty('reservedTicket', $reservedTicket); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The individual reservations included in the package. Typically a repeated + * property. * - * @param string|string[] $name + * @param Reservation|Reservation[] $subReservation * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subReservation */ - public function name($name) + public function subReservation($subReservation) { - return $this->setProperty('name', $name); + return $this->setProperty('subReservation', $subReservation); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param string|string[] $sameAs + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/totalPrice */ - public function sameAs($sameAs) + public function totalPrice($totalPrice) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('totalPrice', $totalPrice); } /** - * A CreativeWork or Event about this Thing. + * The person or organization the reservation or ticket is for. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Organization|Organization[]|Person|Person[] $underName * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/underName */ - public function subjectOf($subjectOf) + public function underName($underName) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('underName', $underName); } /** diff --git a/src/ReserveAction.php b/src/ReserveAction.php index db1403c8f..247289976 100644 --- a/src/ReserveAction.php +++ b/src/ReserveAction.php @@ -22,31 +22,36 @@ class ReserveAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract { /** - * The time the object is scheduled to. + * Indicates the current disposition of the Action. * - * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/scheduledTime + * @see http://schema.org/actionStatus */ - public function scheduledTime($scheduledTime) + public function actionStatus($actionStatus) { - return $this->setProperty('scheduledTime', $scheduledTime); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -65,325 +70,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The time the object is scheduled to. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/scheduledTime */ - public function name($name) + public function scheduledTime($scheduledTime) { - return $this->setProperty('name', $name); + return $this->setProperty('scheduledTime', $scheduledTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Reservoir.php b/src/Reservoir.php index 24fa81c33..f54ca8c64 100644 --- a/src/Reservoir.php +++ b/src/Reservoir.php @@ -38,6 +38,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -67,6 +86,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -147,6 +180,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -235,6 +299,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -309,6 +406,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -351,6 +464,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -393,6 +520,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -436,6 +578,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -483,189 +641,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Residence.php b/src/Residence.php index 9e628db18..d56ae80ec 100644 --- a/src/Residence.php +++ b/src/Residence.php @@ -35,6 +35,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -64,6 +83,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -144,6 +177,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -232,6 +296,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -306,6 +403,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -348,6 +461,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -390,6 +517,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -433,6 +575,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -480,189 +638,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Resort.php b/src/Resort.php index 616f31239..73a3c6b15 100644 --- a/src/Resort.php +++ b/src/Resort.php @@ -24,352 +24,395 @@ class Resort extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/additionalProperty */ - public function amenityFeature($amenityFeature) + public function additionalProperty($additionalProperty) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * An intended audience, i.e. a group for whom something was created. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Audience|Audience[] $audience + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/additionalType */ - public function audience($audience) + public function additionalType($additionalType) { - return $this->setProperty('audience', $audience); + return $this->setProperty('additionalType', $additionalType); } /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * Physical address of the item. * - * @param Language|Language[]|string|string[] $availableLanguage + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/availableLanguage + * @see http://schema.org/address */ - public function availableLanguage($availableLanguage) + public function address($address) { - return $this->setProperty('availableLanguage', $availableLanguage); + return $this->setProperty('address', $address); } /** - * The earliest someone may check into a lodging establishment. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/checkinTime + * @see http://schema.org/aggregateRating */ - public function checkinTime($checkinTime) + public function aggregateRating($aggregateRating) { - return $this->setProperty('checkinTime', $checkinTime); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The latest someone may check out of a lodging establishment. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/checkoutTime + * @see http://schema.org/alternateName */ - public function checkoutTime($checkoutTime) + public function alternateName($alternateName) { - return $this->setProperty('checkoutTime', $checkoutTime); + return $this->setProperty('alternateName', $alternateName); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/amenityFeature */ - public function numberOfRooms($numberOfRooms) + public function amenityFeature($amenityFeature) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * The geographic area where a service or offered item is provided. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/areaServed */ - public function petsAllowed($petsAllowed) + public function areaServed($areaServed) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('areaServed', $areaServed); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * An intended audience, i.e. a group for whom something was created. * - * @param Rating|Rating[] $starRating + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/audience */ - public function starRating($starRating) + public function audience($audience) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('audience', $audience); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] * - * @param Organization|Organization[] $branchOf + * @param Language|Language[]|string|string[] $availableLanguage * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/availableLanguage */ - public function branchOf($branchOf) + public function availableLanguage($availableLanguage) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('availableLanguage', $availableLanguage); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An award won by or for this item. * - * @param string|string[] $currenciesAccepted + * @param string|string[] $award * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/award */ - public function currenciesAccepted($currenciesAccepted) + public function award($award) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('award', $award); } /** - * 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 '-'. + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * The earliest someone may check into a lodging establishment. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param \DateTimeInterface|\DateTimeInterface[] $checkinTime * * @return static * - * @see http://schema.org/address + * @see http://schema.org/checkinTime */ - public function address($address) + public function checkinTime($checkinTime) { - return $this->setProperty('address', $address); + return $this->setProperty('checkinTime', $checkinTime); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The latest someone may check out of a lodging establishment. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param \DateTimeInterface|\DateTimeInterface[] $checkoutTime * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/checkoutTime */ - public function aggregateRating($aggregateRating) + public function checkoutTime($checkoutTime) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('checkoutTime', $checkoutTime); } /** - * The geographic area where a service or offered item is provided. + * A contact point for a person or organization. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/contactPoint */ - public function areaServed($areaServed) + public function contactPoint($contactPoint) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('contactPoint', $contactPoint); } /** - * An award won by or for this item. + * A contact point for a person or organization. * - * @param string|string[] $award + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/award + * @see http://schema.org/contactPoints */ - public function award($award) + public function contactPoints($contactPoints) { - return $this->setProperty('award', $award); + return $this->setProperty('contactPoints', $contactPoints); } /** - * Awards won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $awards + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containedIn */ - public function awards($awards) + public function containedIn($containedIn) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containedIn', $containedIn); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The basic containment relation between a place and one that contains it. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/containedInPlace */ - public function brand($brand) + public function containedInPlace($containedInPlace) { - return $this->setProperty('brand', $brand); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A contact point for a person or organization. + * The basic containment relation between a place and another that it + * contains. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + + /** + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. + * + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -557,6 +600,20 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The geo coordinates of the place. + * + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * + * @return static + * + * @see http://schema.org/geo + */ + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also * referred to as International Location Number or ILN) of the respective @@ -574,6 +631,20 @@ public function globalLocationNumber($globalLocationNumber) return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -604,851 +675,780 @@ public function hasPOS($hasPOS) } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. - * - * @param string|string[] $isicV4 - * - * @return static - * - * @see http://schema.org/isicV4 - */ - public function isicV4($isicV4) - { - return $this->setProperty('isicV4', $isicV4); - } - - /** - * The official name of the organization, e.g. the registered company name. - * - * @param string|string[] $legalName - * - * @return static - * - * @see http://schema.org/legalName - */ - public function legalName($legalName) - { - return $this->setProperty('legalName', $legalName); - } - - /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. - * - * @param string|string[] $leiCode - * - * @return static - * - * @see http://schema.org/leiCode - */ - public function leiCode($leiCode) - { - return $this->setProperty('leiCode', $leiCode); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * An associated logo. - * - * @param ImageObject|ImageObject[]|string|string[] $logo - * - * @return static - * - * @see http://schema.org/logo - */ - public function logo($logo) - { - return $this->setProperty('logo', $logo); - } - - /** - * A pointer to products or services offered by the organization or person. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Offer|Offer[] $makesOffer + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/identifier */ - public function makesOffer($makesOffer) + public function identifier($identifier) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('identifier', $identifier); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $member + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/member + * @see http://schema.org/image */ - public function member($member) + public function image($image) { - return $this->setProperty('member', $member); + return $this->setProperty('image', $image); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/isAccessibleForFree */ - public function memberOf($memberOf) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * A member of this organization. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param Organization|Organization[]|Person|Person[] $members + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isicV4 */ - public function members($members) + public function isicV4($isicV4) { - return $this->setProperty('members', $members); + return $this->setProperty('isicV4', $isicV4); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $naics + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/latitude */ - public function naics($naics) + public function latitude($latitude) { - return $this->setProperty('naics', $naics); + return $this->setProperty('latitude', $latitude); } /** - * The number of employees in an organization e.g. business. + * The official name of the organization, e.g. the registered company name. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/legalName */ - public function numberOfEmployees($numberOfEmployees) + public function legalName($legalName) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('legalName', $legalName); } /** - * A pointer to the organization or person making the offer. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/leiCode */ - public function offeredBy($offeredBy) + public function leiCode($leiCode) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('leiCode', $leiCode); } /** - * Products owned by the organization or person. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/location */ - public function owns($owns) + public function location($location) { - return $this->setProperty('owns', $owns); + return $this->setProperty('location', $location); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * An associated logo. * - * @param Organization|Organization[] $parentOrganization + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/logo */ - public function parentOrganization($parentOrganization) + public function logo($logo) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('logo', $logo); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/longitude */ - public function publishingPrinciples($publishingPrinciples) + public function longitude($longitude) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('longitude', $longitude); } /** - * A review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $review + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/review + * @see http://schema.org/mainEntityOfPage */ - public function review($review) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('review', $review); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Review of the item. + * A pointer to products or services offered by the organization or person. * - * @param Review|Review[] $reviews + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/makesOffer */ - public function reviews($reviews) + public function makesOffer($makesOffer) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A URL to a map of the place. * - * @param Demand|Demand[] $seeks + * @param string|string[] $map * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/map */ - public function seeks($seeks) + public function map($map) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('map', $map); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $maps * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/maps */ - public function serviceArea($serviceArea) + public function maps($maps) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('maps', $maps); } /** - * A slogan or motto associated with the item. + * The total number of individuals that may attend an event or venue. * - * @param string|string[] $slogan + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maximumAttendeeCapacity */ - public function slogan($slogan) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * 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. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/member */ - public function sponsor($sponsor) + public function member($member) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('member', $member); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/memberOf */ - public function subOrganization($subOrganization) + public function memberOf($memberOf) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('memberOf', $memberOf); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * A member of this organization. * - * @param string|string[] $taxID + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/members */ - public function taxID($taxID) + public function members($members) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('members', $members); } /** - * The telephone number. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $telephone + * @param string|string[] $naics * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/naics */ - public function telephone($telephone) + public function naics($naics) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('naics', $naics); } /** - * The Value-added Tax ID of the organization or person. + * The name of the item. * - * @param string|string[] $vatID + * @param string|string[] $name * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/name */ - public function vatID($vatID) + public function name($name) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The number of employees in an organization e.g. business. * - * @param string|string[] $additionalType + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/numberOfEmployees */ - public function additionalType($additionalType) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * An alias for the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param string|string[] $alternateName + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/numberOfRooms */ - public function alternateName($alternateName) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A description of the item. + * A pointer to the organization or person making the offer. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/description + * @see http://schema.org/offeredBy */ - public function description($description) + public function offeredBy($offeredBy) { - return $this->setProperty('description', $description); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/openingHours */ - public function disambiguatingDescription($disambiguatingDescription) + public function openingHours($openingHours) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('openingHours', $openingHours); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The opening hours of a certain place. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHoursSpecification */ - public function identifier($identifier) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Products owned by the organization or person. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/image + * @see http://schema.org/owns */ - public function image($image) + public function owns($owns) { - return $this->setProperty('image', $image); + return $this->setProperty('owns', $owns); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/parentOrganization */ - public function mainEntityOfPage($mainEntityOfPage) + public function parentOrganization($parentOrganization) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The name of the item. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $name + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/name + * @see http://schema.org/paymentAccepted */ - public function name($name) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('name', $name); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param Action|Action[] $potentialAction + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/petsAllowed */ - public function potentialAction($potentialAction) + public function petsAllowed($petsAllowed) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $branchCode + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publicAccess */ - public function branchCode($branchCode) + public function publicAccess($publicAccess) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedIn + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publishingPrinciples */ - public function containedIn($containedIn) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/review */ - public function containedInPlace($containedInPlace) + public function review($review) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and another that it - * contains. + * Review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/reviews */ - public function containsPlace($containsPlace) + public function reviews($reviews) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('reviews', $reviews); } /** - * The geo coordinates of the place. + * 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. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/sameAs */ - public function geo($geo) + public function sameAs($sameAs) { - return $this->setProperty('geo', $geo); + return $this->setProperty('sameAs', $sameAs); } /** - * A URL to a map of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param Map|Map[]|string|string[] $hasMap + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/seeks */ - public function hasMap($hasMap) + public function seeks($seeks) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('seeks', $seeks); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Restaurant.php b/src/Restaurant.php index 285d0f847..64b8327b5 100644 --- a/src/Restaurant.php +++ b/src/Restaurant.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ResumeAction.php b/src/ResumeAction.php index 0cf88bc88..7172bf638 100644 --- a/src/ResumeAction.php +++ b/src/ResumeAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ReturnAction.php b/src/ReturnAction.php index 174cf0d1a..2fb2746ec 100644 --- a/src/ReturnAction.php +++ b/src/ReturnAction.php @@ -16,77 +16,96 @@ class ReturnAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * Indicates the current disposition of the Action. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/actionStatus */ - public function recipient($recipient) + public function actionStatus($actionStatus) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The original location of the object or the - * agent before the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $fromLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/additionalType */ - public function fromLocation($fromLocation) + public function additionalType($additionalType) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Place|Place[] $toLocation + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/agent */ - public function toLocation($toLocation) + public function agent($agent) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -127,288 +146,269 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/location + * @see http://schema.org/fromLocation */ - public function location($location) + public function fromLocation($fromLocation) { - return $this->setProperty('location', $location); + return $this->setProperty('fromLocation', $fromLocation); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $object + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/object + * @see http://schema.org/identifier */ - public function object($object) + public function identifier($identifier) { - return $this->setProperty('object', $object); + return $this->setProperty('identifier', $identifier); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/image */ - public function participant($participant) + public function image($image) { - return $this->setProperty('participant', $participant); + return $this->setProperty('image', $image); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/recipient */ - public function identifier($identifier) + public function recipient($recipient) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('recipient', $recipient); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/Review.php b/src/Review.php index 71f9c1e34..ea8c958bc 100644 --- a/src/Review.php +++ b/src/Review.php @@ -13,66 +13,6 @@ */ class Review extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The item that is being reviewed/rated. - * - * @param Thing|Thing[] $itemReviewed - * - * @return static - * - * @see http://schema.org/itemReviewed - */ - public function itemReviewed($itemReviewed) - { - return $this->setProperty('itemReviewed', $itemReviewed); - } - - /** - * This Review or Rating is relevant to this part or facet of the - * itemReviewed. - * - * @param string|string[] $reviewAspect - * - * @return static - * - * @see http://schema.org/reviewAspect - */ - public function reviewAspect($reviewAspect) - { - return $this->setProperty('reviewAspect', $reviewAspect); - } - - /** - * The actual body of the review. - * - * @param string|string[] $reviewBody - * - * @return static - * - * @see http://schema.org/reviewBody - */ - public function reviewBody($reviewBody) - { - return $this->setProperty('reviewBody', $reviewBody); - } - - /** - * The rating given in this review. Note that reviews can themselves be - * rated. The ```reviewRating``` applies to rating given by the review. The - * [[aggregateRating]] property applies to the review itself, as a creative - * work. - * - * @param Rating|Rating[] $reviewRating - * - * @return static - * - * @see http://schema.org/reviewRating - */ - public function reviewRating($reviewRating) - { - return $this->setProperty('reviewRating', $reviewRating); - } - /** * The subject matter of the content. * @@ -217,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -232,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -523,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -748,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -870,6 +907,20 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The item that is being reviewed/rated. + * + * @param Thing|Thing[] $itemReviewed + * + * @return static + * + * @see http://schema.org/itemReviewed + */ + public function itemReviewed($itemReviewed) + { + return $this->setProperty('itemReviewed', $itemReviewed); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -945,6 +996,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -975,6 +1042,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1005,6 +1086,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1132,6 +1228,52 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * This Review or Rating is relevant to this part or facet of the + * itemReviewed. + * + * @param string|string[] $reviewAspect + * + * @return static + * + * @see http://schema.org/reviewAspect + */ + public function reviewAspect($reviewAspect) + { + return $this->setProperty('reviewAspect', $reviewAspect); + } + + /** + * The actual body of the review. + * + * @param string|string[] $reviewBody + * + * @return static + * + * @see http://schema.org/reviewBody + */ + public function reviewBody($reviewBody) + { + return $this->setProperty('reviewBody', $reviewBody); + } + + /** + * The rating given in this review. Note that reviews can themselves be + * rated. The ```reviewRating``` applies to rating given by the review. The + * [[aggregateRating]] property applies to the review itself, as a creative + * work. + * + * @param Rating|Rating[] $reviewRating + * + * @return static + * + * @see http://schema.org/reviewRating + */ + public function reviewRating($reviewRating) + { + return $this->setProperty('reviewRating', $reviewRating); + } + /** * Review of the item. * @@ -1146,6 +1288,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1228,6 +1386,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1349,6 +1521,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1392,190 +1578,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ReviewAction.php b/src/ReviewAction.php index 0d71289c0..dacf1951f 100644 --- a/src/ReviewAction.php +++ b/src/ReviewAction.php @@ -16,32 +16,36 @@ class ReviewAction extends BaseType implements AssessActionContract, ActionContract, ThingContract { /** - * A sub property of result. The review that resulted in the performing of - * the action. + * Indicates the current disposition of the Action. * - * @param Review|Review[] $resultReview + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/resultReview + * @see http://schema.org/actionStatus */ - public function resultReview($resultReview) + public function actionStatus($actionStatus) { - return $this->setProperty('resultReview', $resultReview); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -60,325 +64,321 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A sub property of result. The review that resulted in the performing of + * the action. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Review|Review[] $resultReview * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/resultReview */ - public function mainEntityOfPage($mainEntityOfPage) + public function resultReview($resultReview) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('resultReview', $resultReview); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/RiverBodyOfWater.php b/src/RiverBodyOfWater.php index c5e173d16..dfd8d7fb3 100644 --- a/src/RiverBodyOfWater.php +++ b/src/RiverBodyOfWater.php @@ -37,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -66,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -146,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -234,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -308,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -350,6 +463,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -392,6 +519,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -435,6 +577,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -482,189 +640,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Role.php b/src/Role.php index 5e6f3e6bc..f0bd4bbf6 100644 --- a/src/Role.php +++ b/src/Role.php @@ -20,69 +20,6 @@ */ class Role extends BaseType implements IntangibleContract, ThingContract { - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * A position played, performed or filled by a person or organization, as - * part of an organization. For example, an athlete in a SportsTeam might - * play in the position named 'Quarterback'. - * - * @param string|string[] $namedPosition - * - * @return static - * - * @see http://schema.org/namedPosition - */ - public function namedPosition($namedPosition) - { - return $this->setProperty('namedPosition', $namedPosition); - } - - /** - * A role played, performed or filled by a person or organization. For - * example, the team of creators for a comic book might fill the roles named - * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might - * play in the position named 'Quarterback'. - * - * @param string|string[] $roleName - * - * @return static - * - * @see http://schema.org/roleName - */ - public function roleName($roleName) - { - return $this->setProperty('roleName', $roleName); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -147,6 +84,21 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -210,6 +162,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * A position played, performed or filled by a person or organization, as + * part of an organization. For example, an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $namedPosition + * + * @return static + * + * @see http://schema.org/namedPosition + */ + public function namedPosition($namedPosition) + { + return $this->setProperty('namedPosition', $namedPosition); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -225,6 +193,23 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * A role played, performed or filled by a person or organization. For + * example, the team of creators for a comic book might fill the roles named + * 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might + * play in the position named 'Quarterback'. + * + * @param string|string[] $roleName + * + * @return static + * + * @see http://schema.org/roleName + */ + public function roleName($roleName) + { + return $this->setProperty('roleName', $roleName); + } + /** * 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 @@ -241,6 +226,21 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + /** * A CreativeWork or Event about this Thing. * diff --git a/src/RoofingContractor.php b/src/RoofingContractor.php index 7de1c0499..0ee1150fd 100644 --- a/src/RoofingContractor.php +++ b/src/RoofingContractor.php @@ -17,126 +17,104 @@ class RoofingContractor extends BaseType implements HomeAndConstructionBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Room.php b/src/Room.php index 215214057..09a7b22bb 100644 --- a/src/Room.php +++ b/src/Room.php @@ -21,133 +21,104 @@ class Room extends BaseType implements AccommodationContract, PlaceContract, ThingContract { /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard - * - * @param QuantitativeValue|QuantitativeValue[] $floorSize - * - * @return static - * - * @see http://schema.org/floorSize - */ - public function floorSize($floorSize) - { - return $this->setProperty('floorSize', $floorSize); - } - - /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/additionalProperty */ - public function numberOfRooms($numberOfRooms) + public function additionalProperty($additionalProperty) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Indications regarding the permitted usage of the accommodation. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $permittedUsage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/permittedUsage + * @see http://schema.org/additionalType */ - public function permittedUsage($permittedUsage) + public function additionalType($additionalType) { - return $this->setProperty('permittedUsage', $permittedUsage); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * Physical address of the item. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/address */ - public function petsAllowed($petsAllowed) + public function address($address) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('address', $address); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/aggregateRating */ - public function additionalProperty($additionalProperty) + public function aggregateRating($aggregateRating) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -213,6 +184,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -256,6 +258,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -301,6 +319,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -375,6 +426,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -418,320 +485,253 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess - * - * @return static - * - * @see http://schema.org/publicAccess - */ - public function publicAccess($publicAccess) - { - return $this->setProperty('publicAccess', $publicAccess); - } - - /** - * A review of the item. + * The name of the item. * - * @param Review|Review[] $review + * @param string|string[] $name * * @return static * - * @see http://schema.org/review + * @see http://schema.org/name */ - public function review($review) + public function name($name) { - return $this->setProperty('review', $review); + return $this->setProperty('name', $name); } /** - * Review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/numberOfRooms */ - public function reviews($reviews) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/RsvpAction.php b/src/RsvpAction.php index 7d8d01a7c..ab4ced288 100644 --- a/src/RsvpAction.php +++ b/src/RsvpAction.php @@ -18,150 +18,139 @@ class RsvpAction extends BaseType implements InformActionContract, CommunicateActionContract, InteractActionContract, ActionContract, ThingContract { /** - * If responding yes, the number of guests who will attend in addition to - * the invitee. - * - * @param float|float[]|int|int[] $additionalNumberOfGuests - * - * @return static - * - * @see http://schema.org/additionalNumberOfGuests - */ - public function additionalNumberOfGuests($additionalNumberOfGuests) - { - return $this->setProperty('additionalNumberOfGuests', $additionalNumberOfGuests); - } - - /** - * Comments, typically from users. + * The subject matter of the content. * - * @param Comment|Comment[] $comment + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/comment + * @see http://schema.org/about */ - public function comment($comment) + public function about($about) { - return $this->setProperty('comment', $comment); + return $this->setProperty('about', $about); } /** - * The response (yes, no, maybe) to the RSVP. + * Indicates the current disposition of the Action. * - * @param RsvpResponseType|RsvpResponseType[] $rsvpResponse + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/rsvpResponse + * @see http://schema.org/actionStatus */ - public function rsvpResponse($rsvpResponse) + public function actionStatus($actionStatus) { - return $this->setProperty('rsvpResponse', $rsvpResponse); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Upcoming or past event associated with this place, organization, or - * action. + * If responding yes, the number of guests who will attend in addition to + * the invitee. * - * @param Event|Event[] $event + * @param float|float[]|int|int[] $additionalNumberOfGuests * * @return static * - * @see http://schema.org/event + * @see http://schema.org/additionalNumberOfGuests */ - public function event($event) + public function additionalNumberOfGuests($additionalNumberOfGuests) { - return $this->setProperty('event', $event); + return $this->setProperty('additionalNumberOfGuests', $additionalNumberOfGuests); } /** - * The subject matter of the content. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $about + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/about + * @see http://schema.org/additionalType */ - public function about($about) + public function additionalType($additionalType) { - return $this->setProperty('about', $about); + return $this->setProperty('additionalType', $additionalType); } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Language|Language[]|string|string[] $inLanguage + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/agent */ - public function inLanguage($inLanguage) + public function agent($agent) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('agent', $agent); } /** - * A sub property of instrument. The language used on this action. + * An alias for the item. * - * @param Language|Language[] $language + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/language + * @see http://schema.org/alternateName */ - public function language($language) + public function alternateName($alternateName) { - return $this->setProperty('language', $language); + return $this->setProperty('alternateName', $alternateName); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * Comments, typically from users. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param Comment|Comment[] $comment * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/comment */ - public function recipient($recipient) + public function comment($comment) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('comment', $comment); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -202,274 +191,271 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param Thing|Thing[] $instrument + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/event */ - public function instrument($instrument) + public function event($event) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('event', $event); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/inLanguage */ - public function participant($participant) + public function inLanguage($inLanguage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('inLanguage', $inLanguage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of instrument. The language used on this action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/language */ - public function startTime($startTime) + public function language($language) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('language', $language); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * The response (yes, no, maybe) to the RSVP. * - * @param string|string[] $name + * @param RsvpResponseType|RsvpResponseType[] $rsvpResponse * * @return static * - * @see http://schema.org/name + * @see http://schema.org/rsvpResponse */ - public function name($name) + public function rsvpResponse($rsvpResponse) { - return $this->setProperty('name', $name); + return $this->setProperty('rsvpResponse', $rsvpResponse); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * 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. * - * @param Action|Action[] $potentialAction + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/sameAs */ - public function potentialAction($potentialAction) + public function sameAs($sameAs) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('sameAs', $sameAs); } /** - * 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. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/startTime */ - public function sameAs($sameAs) + public function startTime($startTime) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('startTime', $startTime); } /** @@ -486,6 +472,20 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + /** * URL of the item. * diff --git a/src/SaleEvent.php b/src/SaleEvent.php index 84245d0ce..82b009569 100644 --- a/src/SaleEvent.php +++ b/src/SaleEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/ScheduleAction.php b/src/ScheduleAction.php index 8d7627995..2e4e09459 100644 --- a/src/ScheduleAction.php +++ b/src/ScheduleAction.php @@ -22,31 +22,36 @@ class ScheduleAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract { /** - * The time the object is scheduled to. + * Indicates the current disposition of the Action. * - * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/scheduledTime + * @see http://schema.org/actionStatus */ - public function scheduledTime($scheduledTime) + public function actionStatus($actionStatus) { - return $this->setProperty('scheduledTime', $scheduledTime); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -65,325 +70,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The time the object is scheduled to. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $scheduledTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/scheduledTime */ - public function name($name) + public function scheduledTime($scheduledTime) { - return $this->setProperty('name', $name); + return $this->setProperty('scheduledTime', $scheduledTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ScholarlyArticle.php b/src/ScholarlyArticle.php index 8e8173671..5ff9f0d49 100644 --- a/src/ScholarlyArticle.php +++ b/src/ScholarlyArticle.php @@ -14,131 +14,6 @@ */ class ScholarlyArticle extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -283,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -298,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -312,6 +220,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -589,6 +526,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -814,6 +782,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1012,8 +1013,24 @@ public function mainEntity($mainEntity) } /** - * A material that something is made from, e.g. leather, wool, cotton, - * paper. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. * * @param Product|Product[]|string|string[] $material * @@ -1041,6 +1058,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1057,6 +1088,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1071,6 +1145,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1212,6 +1301,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1278,6 +1383,45 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + /** * 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 @@ -1294,6 +1438,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1415,6 +1573,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1444,204 +1616,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/School.php b/src/School.php index 07b58274a..d864bed10 100644 --- a/src/School.php +++ b/src/School.php @@ -15,17 +15,22 @@ class School extends BaseType implements EducationalOrganizationContract, OrganizationContract, ThingContract { /** - * Alumni of an organization. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $alumni + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/alumni + * @see http://schema.org/additionalType */ - public function alumni($alumni) + public function additionalType($additionalType) { - return $this->setProperty('alumni', $alumni); + return $this->setProperty('additionalType', $additionalType); } /** @@ -57,6 +62,34 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + + /** + * Alumni of an organization. + * + * @param Person|Person[] $alumni + * + * @return static + * + * @see http://schema.org/alumni + */ + public function alumni($alumni) + { + return $this->setProperty('alumni', $alumni); + } + /** * The geographic area where a service or offered item is provided. * @@ -159,6 +192,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -390,6 +454,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -464,6 +561,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -537,6 +650,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -594,6 +721,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -646,6 +788,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -721,6 +879,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -751,203 +923,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ScreeningEvent.php b/src/ScreeningEvent.php index 45d6419fa..86ca0c607 100644 --- a/src/ScreeningEvent.php +++ b/src/ScreeningEvent.php @@ -13,50 +13,6 @@ */ class ScreeningEvent extends BaseType implements EventContract, ThingContract { - /** - * Languages in which subtitles/captions are available, in [IETF BCP 47 - * standard format](http://tools.ietf.org/html/bcp47). - * - * @param Language|Language[]|string|string[] $subtitleLanguage - * - * @return static - * - * @see http://schema.org/subtitleLanguage - */ - public function subtitleLanguage($subtitleLanguage) - { - return $this->setProperty('subtitleLanguage', $subtitleLanguage); - } - - /** - * The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, - * etc.). - * - * @param string|string[] $videoFormat - * - * @return static - * - * @see http://schema.org/videoFormat - */ - public function videoFormat($videoFormat) - { - return $this->setProperty('videoFormat', $videoFormat); - } - - /** - * The movie presented during this event. - * - * @param Movie|Movie[] $workPresented - * - * @return static - * - * @see http://schema.org/workPresented - */ - public function workPresented($workPresented) - { - return $this->setProperty('workPresented', $workPresented); - } - /** * The subject matter of the content. * @@ -87,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -102,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -173,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -189,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -263,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -309,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -323,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -383,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -443,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -505,6 +619,35 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Languages in which subtitles/captions are available, in [IETF BCP 47 + * standard format](http://tools.ietf.org/html/bcp47). + * + * @param Language|Language[]|string|string[] $subtitleLanguage + * + * @return static + * + * @see http://schema.org/subtitleLanguage + */ + public function subtitleLanguage($subtitleLanguage) + { + return $this->setProperty('subtitleLanguage', $subtitleLanguage); + } + /** * 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 @@ -552,220 +695,77 @@ public function typicalAgeRange($typicalAgeRange) } /** - * 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). - * - * @param CreativeWork|CreativeWork[] $workFeatured - * - * @return static - * - * @see http://schema.org/workFeatured - */ - public function workFeatured($workFeatured) - { - return $this->setProperty('workFeatured', $workFeatured); - } - - /** - * A work performed in some event, for example a play performed in a - * TheaterEvent. - * - * @param CreativeWork|CreativeWork[] $workPerformed - * - * @return static - * - * @see http://schema.org/workPerformed - */ - public function workPerformed($workPerformed) - { - return $this->setProperty('workPerformed', $workPerformed); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. + * URL of the item. * - * @param string|string[] $name + * @param string|string[] $url * * @return static * - * @see http://schema.org/name + * @see http://schema.org/url */ - public function name($name) + public function url($url) { - return $this->setProperty('name', $name); + return $this->setProperty('url', $url); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, + * etc.). * - * @param Action|Action[] $potentialAction + * @param string|string[] $videoFormat * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/videoFormat */ - public function potentialAction($potentialAction) + public function videoFormat($videoFormat) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('videoFormat', $videoFormat); } /** - * 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. + * 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). * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[] $workFeatured * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/workFeatured */ - public function sameAs($sameAs) + public function workFeatured($workFeatured) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('workFeatured', $workFeatured); } /** - * A CreativeWork or Event about this Thing. + * A work performed in some event, for example a play performed in a + * TheaterEvent. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param CreativeWork|CreativeWork[] $workPerformed * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/workPerformed */ - public function subjectOf($subjectOf) + public function workPerformed($workPerformed) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('workPerformed', $workPerformed); } /** - * URL of the item. + * The movie presented during this event. * - * @param string|string[] $url + * @param Movie|Movie[] $workPresented * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workPresented */ - public function url($url) + public function workPresented($workPresented) { - return $this->setProperty('url', $url); + return $this->setProperty('workPresented', $workPresented); } } diff --git a/src/Sculpture.php b/src/Sculpture.php index 54a818ea7..f4be214f9 100644 --- a/src/Sculpture.php +++ b/src/Sculpture.php @@ -157,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -172,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -463,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -688,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -885,6 +982,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -915,6 +1028,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -945,6 +1072,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1086,6 +1228,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1168,6 +1326,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1289,6 +1461,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1332,190 +1518,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/SeaBodyOfWater.php b/src/SeaBodyOfWater.php index 26655d8b5..8df1d35d8 100644 --- a/src/SeaBodyOfWater.php +++ b/src/SeaBodyOfWater.php @@ -37,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -66,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -146,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -234,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -308,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -350,6 +463,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -392,6 +519,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -435,6 +577,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -482,189 +640,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/SearchAction.php b/src/SearchAction.php index a6556c4da..bc78a4357 100644 --- a/src/SearchAction.php +++ b/src/SearchAction.php @@ -19,31 +19,36 @@ class SearchAction extends BaseType implements ActionContract, ThingContract { /** - * A sub property of instrument. The query used on this action. + * Indicates the current disposition of the Action. * - * @param string|string[] $query + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/query + * @see http://schema.org/actionStatus */ - public function query($query) + public function actionStatus($actionStatus) { - return $this->setProperty('query', $query); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -62,325 +67,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of instrument. The query used on this action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $query * * @return static * - * @see http://schema.org/image + * @see http://schema.org/query */ - public function image($image) + public function query($query) { - return $this->setProperty('image', $image); + return $this->setProperty('query', $query); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/SearchResultsPage.php b/src/SearchResultsPage.php index 847240786..2891fdae5 100644 --- a/src/SearchResultsPage.php +++ b/src/SearchResultsPage.php @@ -14,176 +14,6 @@ */ class SearchResultsPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -328,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -343,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -444,6 +307,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -634,6 +512,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -860,13 +769,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -996,6 +938,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1041,6 +998,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1056,6 +1027,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1086,6 +1073,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1116,6 +1117,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1214,6 +1244,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1243,6 +1287,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1257,6 +1316,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1274,6 +1349,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1323,6 +1428,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1339,6 +1497,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1460,6 +1632,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1503,190 +1689,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Season.php b/src/Season.php index 90a4cc5d8..99a51a30b 100644 --- a/src/Season.php +++ b/src/Season.php @@ -157,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -172,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -463,6 +496,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -688,6 +752,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -885,6 +982,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -915,6 +1028,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -945,6 +1072,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1086,6 +1228,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1168,6 +1326,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1289,6 +1461,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1332,190 +1518,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Seat.php b/src/Seat.php index 10c393dca..68416f348 100644 --- a/src/Seat.php +++ b/src/Seat.php @@ -13,62 +13,6 @@ */ class Seat extends BaseType implements IntangibleContract, ThingContract { - /** - * The location of the reserved seat (e.g., 27). - * - * @param string|string[] $seatNumber - * - * @return static - * - * @see http://schema.org/seatNumber - */ - public function seatNumber($seatNumber) - { - return $this->setProperty('seatNumber', $seatNumber); - } - - /** - * The row location of the reserved seat (e.g., B). - * - * @param string|string[] $seatRow - * - * @return static - * - * @see http://schema.org/seatRow - */ - public function seatRow($seatRow) - { - return $this->setProperty('seatRow', $seatRow); - } - - /** - * The section location of the reserved seat (e.g. Orchestra). - * - * @param string|string[] $seatSection - * - * @return static - * - * @see http://schema.org/seatSection - */ - public function seatSection($seatSection) - { - return $this->setProperty('seatSection', $seatSection); - } - - /** - * The type/class of the seat. - * - * @param QualitativeValue|QualitativeValue[]|string|string[] $seatingType - * - * @return static - * - * @see http://schema.org/seatingType - */ - public function seatingType($seatingType) - { - return $this->setProperty('seatingType', $seatingType); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -227,6 +171,62 @@ public function sameAs($sameAs) return $this->setProperty('sameAs', $sameAs); } + /** + * The location of the reserved seat (e.g., 27). + * + * @param string|string[] $seatNumber + * + * @return static + * + * @see http://schema.org/seatNumber + */ + public function seatNumber($seatNumber) + { + return $this->setProperty('seatNumber', $seatNumber); + } + + /** + * The row location of the reserved seat (e.g., B). + * + * @param string|string[] $seatRow + * + * @return static + * + * @see http://schema.org/seatRow + */ + public function seatRow($seatRow) + { + return $this->setProperty('seatRow', $seatRow); + } + + /** + * The section location of the reserved seat (e.g. Orchestra). + * + * @param string|string[] $seatSection + * + * @return static + * + * @see http://schema.org/seatSection + */ + public function seatSection($seatSection) + { + return $this->setProperty('seatSection', $seatSection); + } + + /** + * The type/class of the seat. + * + * @param QualitativeValue|QualitativeValue[]|string|string[] $seatingType + * + * @return static + * + * @see http://schema.org/seatingType + */ + public function seatingType($seatingType) + { + return $this->setProperty('seatingType', $seatingType); + } + /** * A CreativeWork or Event about this Thing. * diff --git a/src/SelfStorage.php b/src/SelfStorage.php index 9a031d0e8..c50064527 100644 --- a/src/SelfStorage.php +++ b/src/SelfStorage.php @@ -16,126 +16,104 @@ class SelfStorage extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SellAction.php b/src/SellAction.php index 91459755a..59a01f08e 100644 --- a/src/SellAction.php +++ b/src/SellAction.php @@ -17,136 +17,111 @@ class SellAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The participant/person/organization that - * bought the object. + * Indicates the current disposition of the Action. * - * @param Person|Person[] $buyer + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/buyer + * @see http://schema.org/actionStatus */ - public function buyer($buyer) + public function actionStatus($actionStatus) { - return $this->setProperty('buyer', $buyer); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The warranty promise(s) included in the offer. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param WarrantyPromise|WarrantyPromise[] $warrantyPromise + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/warrantyPromise + * @see http://schema.org/additionalType */ - public function warrantyPromise($warrantyPromise) + public function additionalType($additionalType) { - return $this->setProperty('warrantyPromise', $warrantyPromise); + return $this->setProperty('additionalType', $additionalType); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param float|float[]|int|int[]|string|string[] $price + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/price + * @see http://schema.org/agent */ - public function price($price) + public function agent($agent) { - return $this->setProperty('price', $price); + return $this->setProperty('agent', $agent); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An alias for the item. * - * @param string|string[] $priceCurrency + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/alternateName */ - public function priceCurrency($priceCurrency) + public function alternateName($alternateName) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('alternateName', $alternateName); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * A sub property of participant. The participant/person/organization that + * bought the object. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param Person|Person[] $buyer * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/buyer */ - public function priceSpecification($priceSpecification) + public function buyer($buyer) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('buyer', $buyer); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -187,302 +162,327 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $instrument + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/identifier */ - public function instrument($instrument) + public function identifier($identifier) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/object + * @see http://schema.org/instrument */ - public function object($object) + public function instrument($instrument) { - return $this->setProperty('object', $object); + return $this->setProperty('instrument', $instrument); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/location */ - public function participant($participant) + public function location($location) { - return $this->setProperty('participant', $participant); + return $this->setProperty('location', $location); } /** - * The result produced in the action. e.g. John wrote *a book*. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $result + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/result + * @see http://schema.org/mainEntityOfPage */ - public function result($result) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('result', $result); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The name of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param string|string[] $name * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/name */ - public function startTime($startTime) + public function name($name) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('name', $name); } /** - * Indicates a target EntryPoint for an Action. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/target + * @see http://schema.org/object */ - public function target($target) + public function object($object) { - return $this->setProperty('target', $target); + return $this->setProperty('object', $object); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/participant */ - public function additionalType($additionalType) + public function participant($participant) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('participant', $participant); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $description + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/description + * @see http://schema.org/price */ - public function description($description) + public function price($price) { - return $this->setProperty('description', $description); + return $this->setProperty('price', $price); } /** - * 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. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/priceCurrency */ - public function disambiguatingDescription($disambiguatingDescription) + public function priceCurrency($priceCurrency) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceSpecification */ - public function identifier($identifier) + public function priceSpecification($priceSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The warranty promise(s) included in the offer. * - * @param string|string[] $url + * @param WarrantyPromise|WarrantyPromise[] $warrantyPromise * * @return static * - * @see http://schema.org/url + * @see http://schema.org/warrantyPromise */ - public function url($url) + public function warrantyPromise($warrantyPromise) { - return $this->setProperty('url', $url); + return $this->setProperty('warrantyPromise', $warrantyPromise); } } diff --git a/src/SendAction.php b/src/SendAction.php index 8f830fbae..72d99f862 100644 --- a/src/SendAction.php +++ b/src/SendAction.php @@ -21,91 +21,110 @@ class SendAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** - * A sub property of instrument. The method of delivery. + * Indicates the current disposition of the Action. * - * @param DeliveryMethod|DeliveryMethod[] $deliveryMethod + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/deliveryMethod + * @see http://schema.org/actionStatus */ - public function deliveryMethod($deliveryMethod) + public function actionStatus($actionStatus) { - return $this->setProperty('deliveryMethod', $deliveryMethod); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/additionalType */ - public function recipient($recipient) + public function additionalType($additionalType) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of location. The original location of the object or the - * agent before the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Place|Place[] $fromLocation + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/agent */ - public function fromLocation($fromLocation) + public function agent($agent) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('agent', $agent); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * An alias for the item. * - * @param Place|Place[] $toLocation + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/alternateName */ - public function toLocation($toLocation) + public function alternateName($alternateName) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A sub property of instrument. The method of delivery. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param DeliveryMethod|DeliveryMethod[] $deliveryMethod * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/deliveryMethod */ - public function actionStatus($actionStatus) + public function deliveryMethod($deliveryMethod) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('deliveryMethod', $deliveryMethod); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -146,288 +165,269 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/location + * @see http://schema.org/fromLocation */ - public function location($location) + public function fromLocation($fromLocation) { - return $this->setProperty('location', $location); + return $this->setProperty('fromLocation', $fromLocation); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $object + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/object + * @see http://schema.org/identifier */ - public function object($object) + public function identifier($identifier) { - return $this->setProperty('object', $object); + return $this->setProperty('identifier', $identifier); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/image */ - public function participant($participant) + public function image($image) { - return $this->setProperty('participant', $participant); + return $this->setProperty('image', $image); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/location */ - public function startTime($startTime) + public function location($location) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('location', $location); } /** - * Indicates a target EntryPoint for an Action. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param EntryPoint|EntryPoint[] $target + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/target + * @see http://schema.org/mainEntityOfPage */ - public function target($target) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('target', $target); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $alternateName + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/object */ - public function alternateName($alternateName) + public function object($object) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('object', $object); } /** - * A description of the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/description + * @see http://schema.org/participant */ - public function description($description) + public function participant($participant) { - return $this->setProperty('description', $description); + return $this->setProperty('participant', $participant); } /** - * 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $disambiguatingDescription + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/potentialAction */ - public function disambiguatingDescription($disambiguatingDescription) + public function potentialAction($potentialAction) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/recipient */ - public function identifier($identifier) + public function recipient($recipient) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('recipient', $recipient); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/Series.php b/src/Series.php index 03b94bf60..cbdee90d5 100644 --- a/src/Series.php +++ b/src/Series.php @@ -15,22 +15,6 @@ */ class Series extends BaseType implements IntangibleContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -78,6 +62,22 @@ public function description($description) return $this->setProperty('description', $description); } + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + /** * A sub property of description. A short description of the item used to * disambiguate from other, similar items. Information from other properties diff --git a/src/Service.php b/src/Service.php index 807e47b9d..3bace54cd 100644 --- a/src/Service.php +++ b/src/Service.php @@ -14,6 +14,25 @@ */ class Service extends BaseType implements IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -29,6 +48,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -133,6 +166,37 @@ public function category($category) return $this->setProperty('category', $category); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -162,6 +226,39 @@ public function hoursAvailable($hoursAvailable) return $this->setProperty('hoursAvailable', $hoursAvailable); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another, somehow related product (or multiple products). * @@ -205,6 +302,36 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -221,6 +348,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The tangible thing generated by the service, e.g. a passport, permit, * etc. @@ -280,6 +422,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The geographic area where the service is provided. * @@ -352,164 +510,6 @@ public function slogan($slogan) return $this->setProperty('slogan', $slogan); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - /** * A CreativeWork or Event about this Thing. * diff --git a/src/ServiceChannel.php b/src/ServiceChannel.php index 89086919d..28eb6a19d 100644 --- a/src/ServiceChannel.php +++ b/src/ServiceChannel.php @@ -15,276 +15,276 @@ class ServiceChannel extends BaseType implements IntangibleContract, ThingContract { /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[]|string|string[] $availableLanguage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/availableLanguage + * @see http://schema.org/additionalType */ - public function availableLanguage($availableLanguage) + public function additionalType($additionalType) { - return $this->setProperty('availableLanguage', $availableLanguage); + return $this->setProperty('additionalType', $additionalType); } /** - * Estimated processing time for the service using this channel. + * An alias for the item. * - * @param Duration|Duration[] $processingTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/processingTime + * @see http://schema.org/alternateName */ - public function processingTime($processingTime) + public function alternateName($alternateName) { - return $this->setProperty('processingTime', $processingTime); + return $this->setProperty('alternateName', $alternateName); } /** - * The service provided by this channel. + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] * - * @param Service|Service[] $providesService + * @param Language|Language[]|string|string[] $availableLanguage * * @return static * - * @see http://schema.org/providesService + * @see http://schema.org/availableLanguage */ - public function providesService($providesService) + public function availableLanguage($availableLanguage) { - return $this->setProperty('providesService', $providesService); + return $this->setProperty('availableLanguage', $availableLanguage); } /** - * The location (e.g. civic structure, local business, etc.) where a person - * can go to access the service. + * A description of the item. * - * @param Place|Place[] $serviceLocation + * @param string|string[] $description * * @return static * - * @see http://schema.org/serviceLocation + * @see http://schema.org/description */ - public function serviceLocation($serviceLocation) + public function description($description) { - return $this->setProperty('serviceLocation', $serviceLocation); + return $this->setProperty('description', $description); } /** - * The phone number to use to access the service. + * 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. * - * @param ContactPoint|ContactPoint[] $servicePhone + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/servicePhone + * @see http://schema.org/disambiguatingDescription */ - public function servicePhone($servicePhone) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('servicePhone', $servicePhone); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The address for accessing the service by mail. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param PostalAddress|PostalAddress[] $servicePostalAddress + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/servicePostalAddress + * @see http://schema.org/identifier */ - public function servicePostalAddress($servicePostalAddress) + public function identifier($identifier) { - return $this->setProperty('servicePostalAddress', $servicePostalAddress); + return $this->setProperty('identifier', $identifier); } /** - * The number to access the service by text message. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param ContactPoint|ContactPoint[] $serviceSmsNumber + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/serviceSmsNumber + * @see http://schema.org/image */ - public function serviceSmsNumber($serviceSmsNumber) + public function image($image) { - return $this->setProperty('serviceSmsNumber', $serviceSmsNumber); + return $this->setProperty('image', $image); } /** - * The website to access the service. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $serviceUrl + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/serviceUrl + * @see http://schema.org/mainEntityOfPage */ - public function serviceUrl($serviceUrl) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('serviceUrl', $serviceUrl); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The name of the item. * - * @param string|string[] $additionalType + * @param string|string[] $name * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/name */ - public function additionalType($additionalType) + public function name($name) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('name', $name); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * Estimated processing time for the service using this channel. * - * @param string|string[] $description + * @param Duration|Duration[] $processingTime * * @return static * - * @see http://schema.org/description + * @see http://schema.org/processingTime */ - public function description($description) + public function processingTime($processingTime) { - return $this->setProperty('description', $description); + return $this->setProperty('processingTime', $processingTime); } /** - * 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. + * The service provided by this channel. * - * @param string|string[] $disambiguatingDescription + * @param Service|Service[] $providesService * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/providesService */ - public function disambiguatingDescription($disambiguatingDescription) + public function providesService($providesService) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('providesService', $providesService); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The location (e.g. civic structure, local business, etc.) where a person + * can go to access the service. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Place|Place[] $serviceLocation * * @return static * - * @see http://schema.org/image + * @see http://schema.org/serviceLocation */ - public function image($image) + public function serviceLocation($serviceLocation) { - return $this->setProperty('image', $image); + return $this->setProperty('serviceLocation', $serviceLocation); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The phone number to use to access the service. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param ContactPoint|ContactPoint[] $servicePhone * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/servicePhone */ - public function mainEntityOfPage($mainEntityOfPage) + public function servicePhone($servicePhone) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('servicePhone', $servicePhone); } /** - * The name of the item. + * The address for accessing the service by mail. * - * @param string|string[] $name + * @param PostalAddress|PostalAddress[] $servicePostalAddress * * @return static * - * @see http://schema.org/name + * @see http://schema.org/servicePostalAddress */ - public function name($name) + public function servicePostalAddress($servicePostalAddress) { - return $this->setProperty('name', $name); + return $this->setProperty('servicePostalAddress', $servicePostalAddress); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The number to access the service by text message. * - * @param Action|Action[] $potentialAction + * @param ContactPoint|ContactPoint[] $serviceSmsNumber * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/serviceSmsNumber */ - public function potentialAction($potentialAction) + public function serviceSmsNumber($serviceSmsNumber) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('serviceSmsNumber', $serviceSmsNumber); } /** - * 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. + * The website to access the service. * - * @param string|string[] $sameAs + * @param string|string[] $serviceUrl * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/serviceUrl */ - public function sameAs($sameAs) + public function serviceUrl($serviceUrl) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('serviceUrl', $serviceUrl); } /** diff --git a/src/ShareAction.php b/src/ShareAction.php index 14161ac60..52f4c7eac 100644 --- a/src/ShareAction.php +++ b/src/ShareAction.php @@ -30,78 +30,96 @@ public function about($about) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * Indicates the current disposition of the Action. * - * @param Language|Language[]|string|string[] $inLanguage + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/actionStatus */ - public function inLanguage($inLanguage) + public function actionStatus($actionStatus) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of instrument. The language used on this action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Language|Language[] $language + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/language + * @see http://schema.org/additionalType */ - public function language($language) + public function additionalType($additionalType) { - return $this->setProperty('language', $language); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/agent */ - public function recipient($recipient) + public function agent($agent) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -142,288 +160,270 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/inLanguage */ - public function participant($participant) + public function inLanguage($inLanguage) { - return $this->setProperty('participant', $participant); + return $this->setProperty('inLanguage', $inLanguage); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $result + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/result + * @see http://schema.org/instrument */ - public function result($result) + public function instrument($instrument) { - return $this->setProperty('result', $result); + return $this->setProperty('instrument', $instrument); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of instrument. The language used on this action. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/language */ - public function startTime($startTime) + public function language($language) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('language', $language); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/ShoeStore.php b/src/ShoeStore.php index d02093240..00d35eb1f 100644 --- a/src/ShoeStore.php +++ b/src/ShoeStore.php @@ -17,126 +17,104 @@ class ShoeStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ShoppingCenter.php b/src/ShoppingCenter.php index 1521e4ff9..aef93e206 100644 --- a/src/ShoppingCenter.php +++ b/src/ShoppingCenter.php @@ -16,126 +16,104 @@ class ShoppingCenter extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SingleFamilyResidence.php b/src/SingleFamilyResidence.php index f7f2eab6c..3c9535f10 100644 --- a/src/SingleFamilyResidence.php +++ b/src/SingleFamilyResidence.php @@ -16,168 +16,104 @@ class SingleFamilyResidence extends BaseType implements HouseContract, AccommodationContract, PlaceContract, ThingContract { /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms - * - * @return static - * - * @see http://schema.org/numberOfRooms - */ - public function numberOfRooms($numberOfRooms) - { - return $this->setProperty('numberOfRooms', $numberOfRooms); - } - - /** - * The allowed total occupancy for the accommodation in persons (including - * infants etc). For individual accommodations, this is not necessarily the - * legal maximum but defines the permitted usage as per the contractual - * agreement (e.g. a double room used by a single person). - * Typical unit code(s): C62 for person - * - * @param QuantitativeValue|QuantitativeValue[] $occupancy - * - * @return static - * - * @see http://schema.org/occupancy - */ - public function occupancy($occupancy) - { - return $this->setProperty('occupancy', $occupancy); - } - - /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms - * - * @return static - * - * @see http://schema.org/numberOfRooms - */ - public function numberOfRooms($numberOfRooms) - { - return $this->setProperty('numberOfRooms', $numberOfRooms); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[] $floorSize + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/floorSize + * @see http://schema.org/additionalProperty */ - public function floorSize($floorSize) + public function additionalProperty($additionalProperty) { - return $this->setProperty('floorSize', $floorSize); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Indications regarding the permitted usage of the accommodation. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $permittedUsage + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/permittedUsage + * @see http://schema.org/additionalType */ - public function permittedUsage($permittedUsage) + public function additionalType($additionalType) { - return $this->setProperty('permittedUsage', $permittedUsage); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * Physical address of the item. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/address */ - public function petsAllowed($petsAllowed) + public function address($address) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('address', $address); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/aggregateRating */ - public function additionalProperty($additionalProperty) + public function aggregateRating($aggregateRating) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -243,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -286,6 +253,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -331,6 +314,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -405,6 +421,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -448,320 +480,271 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. + * The name of the item. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value - * - * @param bool|bool[] $publicAccess + * @param string|string[] $name * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/name */ - public function publicAccess($publicAccess) + public function name($name) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('name', $name); } /** - * A review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $review + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/review + * @see http://schema.org/numberOfRooms */ - public function review($review) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('review', $review); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * Review of the item. + * The allowed total occupancy for the accommodation in persons (including + * infants etc). For individual accommodations, this is not necessarily the + * legal maximum but defines the permitted usage as per the contractual + * agreement (e.g. a double room used by a single person). + * Typical unit code(s): C62 for person * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[] $occupancy * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/occupancy */ - public function reviews($reviews) + public function occupancy($occupancy) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('occupancy', $occupancy); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/SiteNavigationElement.php b/src/SiteNavigationElement.php index 24dc07b88..0bd178532 100644 --- a/src/SiteNavigationElement.php +++ b/src/SiteNavigationElement.php @@ -11,6 +11,8 @@ * * @see http://schema.org/SiteNavigationElement * + * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] + * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ class SiteNavigationElement extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { @@ -158,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -173,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -464,6 +499,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -689,6 +755,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -886,6 +985,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -916,6 +1031,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -946,6 +1075,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1087,6 +1231,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1169,6 +1329,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1290,6 +1464,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1333,190 +1521,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/SkiResort.php b/src/SkiResort.php index cc3b7b3e0..17d2b256e 100644 --- a/src/SkiResort.php +++ b/src/SkiResort.php @@ -17,126 +17,104 @@ class SkiResort extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SocialEvent.php b/src/SocialEvent.php index fe8e03150..c9114b134 100644 --- a/src/SocialEvent.php +++ b/src/SocialEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/SocialMediaPosting.php b/src/SocialMediaPosting.php index e32d7ac0a..57873a40b 100644 --- a/src/SocialMediaPosting.php +++ b/src/SocialMediaPosting.php @@ -15,146 +15,6 @@ */ class SocialMediaPosting extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { - /** - * A CreativeWork such as an image, video, or audio clip shared as part of - * this posting. - * - * @param CreativeWork|CreativeWork[] $sharedContent - * - * @return static - * - * @see http://schema.org/sharedContent - */ - public function sharedContent($sharedContent) - { - return $this->setProperty('sharedContent', $sharedContent); - } - - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -299,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -314,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -328,6 +221,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -605,6 +527,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -831,28 +784,61 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Language|Language[]|string|string[] $inLanguage + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/identifier */ - public function inLanguage($inLanguage) + public function identifier($identifier) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('identifier', $identifier); } /** - * The number of interactions for the CreativeWork using the WebSite or - * SoftwareApplication. The most specific child type of InteractionCounter - * should be used. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param InteractionCounter|InteractionCounter[] $interactionStatistic + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * + * @return static + * + * @see http://schema.org/inLanguage + */ + public function inLanguage($inLanguage) + { + return $this->setProperty('inLanguage', $inLanguage); + } + + /** + * The number of interactions for the CreativeWork using the WebSite or + * SoftwareApplication. The most specific child type of InteractionCounter + * should be used. + * + * @param InteractionCounter|InteractionCounter[] $interactionStatistic * * @return static * @@ -1027,6 +1013,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1057,6 +1059,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1073,6 +1089,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1087,6 +1146,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1228,6 +1302,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1245,6 +1335,21 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A CreativeWork such as an image, video, or audio clip shared as part of + * this posting. + * + * @param CreativeWork|CreativeWork[] $sharedContent + * + * @return static + * + * @see http://schema.org/sharedContent + */ + public function sharedContent($sharedContent) + { + return $this->setProperty('sharedContent', $sharedContent); + } + /** * The Organization on whose behalf the creator was working. * @@ -1294,6 +1399,45 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + /** * 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 @@ -1310,6 +1454,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1431,6 +1589,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1460,204 +1632,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/SoftwareApplication.php b/src/SoftwareApplication.php index e9503410c..e7dded7e5 100644 --- a/src/SoftwareApplication.php +++ b/src/SoftwareApplication.php @@ -13,357 +13,6 @@ */ class SoftwareApplication extends BaseType implements CreativeWorkContract, ThingContract { - /** - * Type of software application, e.g. 'Game, Multimedia'. - * - * @param string|string[] $applicationCategory - * - * @return static - * - * @see http://schema.org/applicationCategory - */ - public function applicationCategory($applicationCategory) - { - return $this->setProperty('applicationCategory', $applicationCategory); - } - - /** - * Subcategory of the application, e.g. 'Arcade Game'. - * - * @param string|string[] $applicationSubCategory - * - * @return static - * - * @see http://schema.org/applicationSubCategory - */ - public function applicationSubCategory($applicationSubCategory) - { - return $this->setProperty('applicationSubCategory', $applicationSubCategory); - } - - /** - * The name of the application suite to which the application belongs (e.g. - * Excel belongs to Office). - * - * @param string|string[] $applicationSuite - * - * @return static - * - * @see http://schema.org/applicationSuite - */ - public function applicationSuite($applicationSuite) - { - return $this->setProperty('applicationSuite', $applicationSuite); - } - - /** - * Device required to run the application. Used in cases where a specific - * make/model is required to run the application. - * - * @param string|string[] $availableOnDevice - * - * @return static - * - * @see http://schema.org/availableOnDevice - */ - public function availableOnDevice($availableOnDevice) - { - return $this->setProperty('availableOnDevice', $availableOnDevice); - } - - /** - * Countries for which the application is not supported. You can also - * provide the two-letter ISO 3166-1 alpha-2 country code. - * - * @param string|string[] $countriesNotSupported - * - * @return static - * - * @see http://schema.org/countriesNotSupported - */ - public function countriesNotSupported($countriesNotSupported) - { - return $this->setProperty('countriesNotSupported', $countriesNotSupported); - } - - /** - * Countries for which the application is supported. You can also provide - * the two-letter ISO 3166-1 alpha-2 country code. - * - * @param string|string[] $countriesSupported - * - * @return static - * - * @see http://schema.org/countriesSupported - */ - public function countriesSupported($countriesSupported) - { - return $this->setProperty('countriesSupported', $countriesSupported); - } - - /** - * Device required to run the application. Used in cases where a specific - * make/model is required to run the application. - * - * @param string|string[] $device - * - * @return static - * - * @see http://schema.org/device - */ - public function device($device) - { - return $this->setProperty('device', $device); - } - - /** - * If the file can be downloaded, URL to download the binary. - * - * @param string|string[] $downloadUrl - * - * @return static - * - * @see http://schema.org/downloadUrl - */ - public function downloadUrl($downloadUrl) - { - return $this->setProperty('downloadUrl', $downloadUrl); - } - - /** - * Features or modules provided by this application (and possibly required - * by other applications). - * - * @param string|string[] $featureList - * - * @return static - * - * @see http://schema.org/featureList - */ - public function featureList($featureList) - { - return $this->setProperty('featureList', $featureList); - } - - /** - * Size of the application / package (e.g. 18MB). In the absence of a unit - * (MB, KB etc.), KB will be assumed. - * - * @param string|string[] $fileSize - * - * @return static - * - * @see http://schema.org/fileSize - */ - public function fileSize($fileSize) - { - return $this->setProperty('fileSize', $fileSize); - } - - /** - * URL at which the app may be installed, if different from the URL of the - * item. - * - * @param string|string[] $installUrl - * - * @return static - * - * @see http://schema.org/installUrl - */ - public function installUrl($installUrl) - { - return $this->setProperty('installUrl', $installUrl); - } - - /** - * Minimum memory requirements. - * - * @param string|string[] $memoryRequirements - * - * @return static - * - * @see http://schema.org/memoryRequirements - */ - public function memoryRequirements($memoryRequirements) - { - return $this->setProperty('memoryRequirements', $memoryRequirements); - } - - /** - * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). - * - * @param string|string[] $operatingSystem - * - * @return static - * - * @see http://schema.org/operatingSystem - */ - public function operatingSystem($operatingSystem) - { - return $this->setProperty('operatingSystem', $operatingSystem); - } - - /** - * Permission(s) required to run the app (for example, a mobile app may - * require full internet access or may run only on wifi). - * - * @param string|string[] $permissions - * - * @return static - * - * @see http://schema.org/permissions - */ - public function permissions($permissions) - { - return $this->setProperty('permissions', $permissions); - } - - /** - * Processor architecture required to run the application (e.g. IA64). - * - * @param string|string[] $processorRequirements - * - * @return static - * - * @see http://schema.org/processorRequirements - */ - public function processorRequirements($processorRequirements) - { - return $this->setProperty('processorRequirements', $processorRequirements); - } - - /** - * Description of what changed in this version. - * - * @param string|string[] $releaseNotes - * - * @return static - * - * @see http://schema.org/releaseNotes - */ - public function releaseNotes($releaseNotes) - { - return $this->setProperty('releaseNotes', $releaseNotes); - } - - /** - * Component dependency requirements for application. This includes runtime - * environments and shared libraries that are not included in the - * application distribution package, but required to run the application - * (Examples: DirectX, Java or .NET runtime). - * - * @param string|string[] $requirements - * - * @return static - * - * @see http://schema.org/requirements - */ - public function requirements($requirements) - { - return $this->setProperty('requirements', $requirements); - } - - /** - * A link to a screenshot image of the app. - * - * @param ImageObject|ImageObject[]|string|string[] $screenshot - * - * @return static - * - * @see http://schema.org/screenshot - */ - public function screenshot($screenshot) - { - return $this->setProperty('screenshot', $screenshot); - } - - /** - * Additional content for a software application. - * - * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn - * - * @return static - * - * @see http://schema.org/softwareAddOn - */ - public function softwareAddOn($softwareAddOn) - { - return $this->setProperty('softwareAddOn', $softwareAddOn); - } - - /** - * Software application help. - * - * @param CreativeWork|CreativeWork[] $softwareHelp - * - * @return static - * - * @see http://schema.org/softwareHelp - */ - public function softwareHelp($softwareHelp) - { - return $this->setProperty('softwareHelp', $softwareHelp); - } - - /** - * Component dependency requirements for application. This includes runtime - * environments and shared libraries that are not included in the - * application distribution package, but required to run the application - * (Examples: DirectX, Java or .NET runtime). - * - * @param string|string[] $softwareRequirements - * - * @return static - * - * @see http://schema.org/softwareRequirements - */ - public function softwareRequirements($softwareRequirements) - { - return $this->setProperty('softwareRequirements', $softwareRequirements); - } - - /** - * Version of the software instance. - * - * @param string|string[] $softwareVersion - * - * @return static - * - * @see http://schema.org/softwareVersion - */ - public function softwareVersion($softwareVersion) - { - return $this->setProperty('softwareVersion', $softwareVersion); - } - - /** - * Storage requirements (free space required). - * - * @param string|string[] $storageRequirements - * - * @return static - * - * @see http://schema.org/storageRequirements - */ - public function storageRequirements($storageRequirements) - { - return $this->setProperty('storageRequirements', $storageRequirements); - } - - /** - * Supporting data for a SoftwareApplication. - * - * @param DataFeed|DataFeed[] $supportingData - * - * @return static - * - * @see http://schema.org/supportingData - */ - public function supportingData($supportingData) - { - return $this->setProperty('supportingData', $supportingData); - } - /** * The subject matter of the content. * @@ -508,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -523,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -537,6 +219,49 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * Type of software application, e.g. 'Game, Multimedia'. + * + * @param string|string[] $applicationCategory + * + * @return static + * + * @see http://schema.org/applicationCategory + */ + public function applicationCategory($applicationCategory) + { + return $this->setProperty('applicationCategory', $applicationCategory); + } + + /** + * Subcategory of the application, e.g. 'Arcade Game'. + * + * @param string|string[] $applicationSubCategory + * + * @return static + * + * @see http://schema.org/applicationSubCategory + */ + public function applicationSubCategory($applicationSubCategory) + { + return $this->setProperty('applicationSubCategory', $applicationSubCategory); + } + + /** + * The name of the application suite to which the application belongs (e.g. + * Excel belongs to Office). + * + * @param string|string[] $applicationSuite + * + * @return static + * + * @see http://schema.org/applicationSuite + */ + public function applicationSuite($applicationSuite) + { + return $this->setProperty('applicationSuite', $applicationSuite); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -596,6 +321,21 @@ public function author($author) return $this->setProperty('author', $author); } + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $availableOnDevice + * + * @return static + * + * @see http://schema.org/availableOnDevice + */ + public function availableOnDevice($availableOnDevice) + { + return $this->setProperty('availableOnDevice', $availableOnDevice); + } + /** * An award won by or for this item. * @@ -755,6 +495,36 @@ public function copyrightYear($copyrightYear) return $this->setProperty('copyrightYear', $copyrightYear); } + /** + * Countries for which the application is not supported. You can also + * provide the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesNotSupported + * + * @return static + * + * @see http://schema.org/countriesNotSupported + */ + public function countriesNotSupported($countriesNotSupported) + { + return $this->setProperty('countriesNotSupported', $countriesNotSupported); + } + + /** + * Countries for which the application is supported. You can also provide + * the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesSupported + * + * @return static + * + * @see http://schema.org/countriesSupported + */ + public function countriesSupported($countriesSupported) + { + return $this->setProperty('countriesSupported', $countriesSupported); + } + /** * The creator/author of this CreativeWork. This is the same as the Author * property for CreativeWork. @@ -814,6 +584,52 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $device + * + * @return static + * + * @see http://schema.org/device + */ + public function device($device) + { + return $this->setProperty('device', $device); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -828,6 +644,20 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * If the file can be downloaded, URL to download the binary. + * + * @param string|string[] $downloadUrl + * + * @return static + * + * @see http://schema.org/downloadUrl + */ + public function downloadUrl($downloadUrl) + { + return $this->setProperty('downloadUrl', $downloadUrl); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -960,6 +790,21 @@ public function expires($expires) return $this->setProperty('expires', $expires); } + /** + * Features or modules provided by this application (and possibly required + * by other applications). + * + * @param string|string[] $featureList + * + * @return static + * + * @see http://schema.org/featureList + */ + public function featureList($featureList) + { + return $this->setProperty('featureList', $featureList); + } + /** * Media type, typically MIME format (see [IANA * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of @@ -981,6 +826,21 @@ public function fileFormat($fileFormat) return $this->setProperty('fileFormat', $fileFormat); } + /** + * Size of the application / package (e.g. 18MB). In the absence of a unit + * (MB, KB etc.), KB will be assumed. + * + * @param string|string[] $fileSize + * + * @return static + * + * @see http://schema.org/fileSize + */ + public function fileSize($fileSize) + { + return $this->setProperty('fileSize', $fileSize); + } + /** * A person or organization that supports (sponsors) something through some * kind of financial contribution. @@ -1018,25 +878,58 @@ public function genre($genre) * * @return static * - * @see http://schema.org/hasPart + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier */ - public function hasPart($hasPart) + public function identifier($identifier) { - return $this->setProperty('hasPart', $hasPart); + return $this->setProperty('identifier', $identifier); } /** - * Headline of the article. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $headline + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/headline + * @see http://schema.org/image */ - public function headline($headline) + public function image($image) { - return $this->setProperty('headline', $headline); + return $this->setProperty('image', $image); } /** @@ -1056,6 +949,21 @@ public function inLanguage($inLanguage) return $this->setProperty('inLanguage', $inLanguage); } + /** + * URL at which the app may be installed, if different from the URL of the + * item. + * + * @param string|string[] $installUrl + * + * @return static + * + * @see http://schema.org/installUrl + */ + public function installUrl($installUrl) + { + return $this->setProperty('installUrl', $installUrl); + } + /** * The number of interactions for the CreativeWork using the WebSite or * SoftwareApplication. The most specific child type of InteractionCounter @@ -1236,6 +1144,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1251,6 +1175,20 @@ public function material($material) return $this->setProperty('material', $material); } + /** + * Minimum memory requirements. + * + * @param string|string[] $memoryRequirements + * + * @return static + * + * @see http://schema.org/memoryRequirements + */ + public function memoryRequirements($memoryRequirements) + { + return $this->setProperty('memoryRequirements', $memoryRequirements); + } + /** * Indicates that the CreativeWork contains a reference to, but is not * necessarily about a concept. @@ -1266,6 +1204,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1282,6 +1234,35 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). + * + * @param string|string[] $operatingSystem + * + * @return static + * + * @see http://schema.org/operatingSystem + */ + public function operatingSystem($operatingSystem) + { + return $this->setProperty('operatingSystem', $operatingSystem); + } + + /** + * Permission(s) required to run the app (for example, a mobile app may + * require full internet access or may run only on wifi). + * + * @param string|string[] $permissions + * + * @return static + * + * @see http://schema.org/permissions + */ + public function permissions($permissions) + { + return $this->setProperty('permissions', $permissions); + } + /** * The position of an item in a series or sequence of items. * @@ -1296,6 +1277,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Processor architecture required to run the application (e.g. IA64). + * + * @param string|string[] $processorRequirements + * + * @return static + * + * @see http://schema.org/processorRequirements + */ + public function processorRequirements($processorRequirements) + { + return $this->setProperty('processorRequirements', $processorRequirements); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1394,6 +1404,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * Description of what changed in this version. + * + * @param string|string[] $releaseNotes + * + * @return static + * + * @see http://schema.org/releaseNotes + */ + public function releaseNotes($releaseNotes) + { + return $this->setProperty('releaseNotes', $releaseNotes); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1409,6 +1433,23 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $requirements + * + * @return static + * + * @see http://schema.org/requirements + */ + public function requirements($requirements) + { + return $this->setProperty('requirements', $requirements); + } + /** * A review of the item. * @@ -1438,20 +1479,109 @@ public function reviews($reviews) } /** - * Indicates (by URL or string) a particular version of a schema used in - * some CreativeWork. For example, a document could declare a schemaVersion - * using an URL such as http://schema.org/version/2.0/ if precise indication - * of schema version was required by some application. + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * A link to a screenshot image of the app. + * + * @param ImageObject|ImageObject[]|string|string[] $screenshot + * + * @return static + * + * @see http://schema.org/screenshot + */ + public function screenshot($screenshot) + { + return $this->setProperty('screenshot', $screenshot); + } + + /** + * Additional content for a software application. + * + * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn + * + * @return static + * + * @see http://schema.org/softwareAddOn + */ + public function softwareAddOn($softwareAddOn) + { + return $this->setProperty('softwareAddOn', $softwareAddOn); + } + + /** + * Software application help. + * + * @param CreativeWork|CreativeWork[] $softwareHelp + * + * @return static + * + * @see http://schema.org/softwareHelp + */ + public function softwareHelp($softwareHelp) + { + return $this->setProperty('softwareHelp', $softwareHelp); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $softwareRequirements + * + * @return static + * + * @see http://schema.org/softwareRequirements + */ + public function softwareRequirements($softwareRequirements) + { + return $this->setProperty('softwareRequirements', $softwareRequirements); + } + + /** + * Version of the software instance. * - * @param string|string[] $schemaVersion + * @param string|string[] $softwareVersion * * @return static * - * @see http://schema.org/schemaVersion + * @see http://schema.org/softwareVersion */ - public function schemaVersion($schemaVersion) + public function softwareVersion($softwareVersion) { - return $this->setProperty('schemaVersion', $schemaVersion); + return $this->setProperty('softwareVersion', $softwareVersion); } /** @@ -1519,6 +1649,48 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * Storage requirements (free space required). + * + * @param string|string[] $storageRequirements + * + * @return static + * + * @see http://schema.org/storageRequirements + */ + public function storageRequirements($storageRequirements) + { + return $this->setProperty('storageRequirements', $storageRequirements); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Supporting data for a SoftwareApplication. + * + * @param DataFeed|DataFeed[] $supportingData + * + * @return static + * + * @see http://schema.org/supportingData + */ + public function supportingData($supportingData) + { + return $this->setProperty('supportingData', $supportingData); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1640,6 +1812,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1683,190 +1869,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/SoftwareSourceCode.php b/src/SoftwareSourceCode.php index e96ee4cd7..ffd287bce 100644 --- a/src/SoftwareSourceCode.php +++ b/src/SoftwareSourceCode.php @@ -14,110 +14,6 @@ */ class SoftwareSourceCode extends BaseType implements CreativeWorkContract, ThingContract { - /** - * Link to the repository where the un-compiled, human readable code and - * related code is located (SVN, github, CodePlex). - * - * @param string|string[] $codeRepository - * - * @return static - * - * @see http://schema.org/codeRepository - */ - public function codeRepository($codeRepository) - { - return $this->setProperty('codeRepository', $codeRepository); - } - - /** - * What type of code sample: full (compile ready) solution, code snippet, - * inline code, scripts, template. - * - * @param string|string[] $codeSampleType - * - * @return static - * - * @see http://schema.org/codeSampleType - */ - public function codeSampleType($codeSampleType) - { - return $this->setProperty('codeSampleType', $codeSampleType); - } - - /** - * The computer programming language. - * - * @param ComputerLanguage|ComputerLanguage[]|string|string[] $programmingLanguage - * - * @return static - * - * @see http://schema.org/programmingLanguage - */ - public function programmingLanguage($programmingLanguage) - { - return $this->setProperty('programmingLanguage', $programmingLanguage); - } - - /** - * Runtime platform or script interpreter dependencies (Example - Java v1, - * Python2.3, .Net Framework 3.0). - * - * @param string|string[] $runtime - * - * @return static - * - * @see http://schema.org/runtime - */ - public function runtime($runtime) - { - return $this->setProperty('runtime', $runtime); - } - - /** - * Runtime platform or script interpreter dependencies (Example - Java v1, - * Python2.3, .Net Framework 3.0). - * - * @param string|string[] $runtimePlatform - * - * @return static - * - * @see http://schema.org/runtimePlatform - */ - public function runtimePlatform($runtimePlatform) - { - return $this->setProperty('runtimePlatform', $runtimePlatform); - } - - /** - * What type of code sample: full (compile ready) solution, code snippet, - * inline code, scripts, template. - * - * @param string|string[] $sampleType - * - * @return static - * - * @see http://schema.org/sampleType - */ - public function sampleType($sampleType) - { - return $this->setProperty('sampleType', $sampleType); - } - - /** - * Target Operating System / Product to which the code applies. If applies - * to several versions, just the product name can be used. - * - * @param SoftwareApplication|SoftwareApplication[] $targetProduct - * - * @return static - * - * @see http://schema.org/targetProduct - */ - public function targetProduct($targetProduct) - { - return $this->setProperty('targetProduct', $targetProduct); - } - /** * The subject matter of the content. * @@ -262,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -277,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -407,6 +336,36 @@ public function citation($citation) return $this->setProperty('citation', $citation); } + /** + * Link to the repository where the un-compiled, human readable code and + * related code is located (SVN, github, CodePlex). + * + * @param string|string[] $codeRepository + * + * @return static + * + * @see http://schema.org/codeRepository + */ + public function codeRepository($codeRepository) + { + return $this->setProperty('codeRepository', $codeRepository); + } + + /** + * What type of code sample: full (compile ready) solution, code snippet, + * inline code, scripts, template. + * + * @param string|string[] $codeSampleType + * + * @return static + * + * @see http://schema.org/codeSampleType + */ + public function codeSampleType($codeSampleType) + { + return $this->setProperty('codeSampleType', $codeSampleType); + } + /** * Comments, typically from users. * @@ -568,6 +527,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -793,6 +783,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -990,6 +1013,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1021,17 +1060,31 @@ public function mentions($mentions) } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * The name of the item. * - * @param Offer|Offer[] $offers + * @param string|string[] $name * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/name */ - public function offers($offers) + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) { return $this->setProperty('offers', $offers); } @@ -1050,6 +1103,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1065,6 +1133,20 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The computer programming language. + * + * @param ComputerLanguage|ComputerLanguage[]|string|string[] $programmingLanguage + * + * @return static + * + * @see http://schema.org/programmingLanguage + */ + public function programmingLanguage($programmingLanguage) + { + return $this->setProperty('programmingLanguage', $programmingLanguage); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1191,6 +1273,67 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * Runtime platform or script interpreter dependencies (Example - Java v1, + * Python2.3, .Net Framework 3.0). + * + * @param string|string[] $runtime + * + * @return static + * + * @see http://schema.org/runtime + */ + public function runtime($runtime) + { + return $this->setProperty('runtime', $runtime); + } + + /** + * Runtime platform or script interpreter dependencies (Example - Java v1, + * Python2.3, .Net Framework 3.0). + * + * @param string|string[] $runtimePlatform + * + * @return static + * + * @see http://schema.org/runtimePlatform + */ + public function runtimePlatform($runtimePlatform) + { + return $this->setProperty('runtimePlatform', $runtimePlatform); + } + + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * What type of code sample: full (compile ready) solution, code snippet, + * inline code, scripts, template. + * + * @param string|string[] $sampleType + * + * @return static + * + * @see http://schema.org/sampleType + */ + public function sampleType($sampleType) + { + return $this->setProperty('sampleType', $sampleType); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1273,6 +1416,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Target Operating System / Product to which the code applies. If applies + * to several versions, just the product name can be used. + * + * @param SoftwareApplication|SoftwareApplication[] $targetProduct + * + * @return static + * + * @see http://schema.org/targetProduct + */ + public function targetProduct($targetProduct) + { + return $this->setProperty('targetProduct', $targetProduct); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1394,6 +1566,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1437,190 +1623,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/SomeProducts.php b/src/SomeProducts.php index a0ec6637e..1d8f42c3f 100644 --- a/src/SomeProducts.php +++ b/src/SomeProducts.php @@ -13,20 +13,6 @@ */ class SomeProducts extends BaseType implements ProductContract, ThingContract { - /** - * The current approximate inventory level for the item or items. - * - * @param QuantitativeValue|QuantitativeValue[] $inventoryLevel - * - * @return static - * - * @see http://schema.org/inventoryLevel - */ - public function inventoryLevel($inventoryLevel) - { - return $this->setProperty('inventoryLevel', $inventoryLevel); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -49,6 +35,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -64,6 +69,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An intended audience, i.e. a group for whom something was created. * @@ -164,6 +183,37 @@ public function depth($depth) return $this->setProperty('depth', $depth); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The GTIN-12 code of the product, or the product to which the offer * refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a @@ -251,6 +301,53 @@ public function height($height) return $this->setProperty('height', $height); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * The current approximate inventory level for the item or items. + * + * @param QuantitativeValue|QuantitativeValue[] $inventoryLevel + * + * @return static + * + * @see http://schema.org/inventoryLevel + */ + public function inventoryLevel($inventoryLevel) + { + return $this->setProperty('inventoryLevel', $inventoryLevel); + } + /** * A pointer to another product (or multiple products) for which this * product is an accessory or spare part. @@ -340,6 +437,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The manufacturer of the product. * @@ -402,6 +515,20 @@ public function mpn($mpn) return $this->setProperty('mpn', $mpn); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -418,6 +545,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The product identifier, such as ISBN. For example: ``` meta * itemprop="productID" content="isbn:123-456-789" ```. @@ -504,6 +646,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a * product or service, or the product to which the offer refers. @@ -534,217 +692,59 @@ public function slogan($slogan) } /** - * The weight of the product or person. - * - * @param QuantitativeValue|QuantitativeValue[] $weight - * - * @return static - * - * @see http://schema.org/weight - */ - public function weight($weight) - { - return $this->setProperty('weight', $weight); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * URL of the item. * - * @param string|string[] $sameAs + * @param string|string[] $url * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/url */ - public function sameAs($sameAs) + public function url($url) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('url', $url); } /** - * A CreativeWork or Event about this Thing. + * The weight of the product or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param QuantitativeValue|QuantitativeValue[] $weight * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/weight */ - public function subjectOf($subjectOf) + public function weight($weight) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('weight', $weight); } /** - * URL of the item. + * The width of the item. * - * @param string|string[] $url + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/url + * @see http://schema.org/width */ - public function url($url) + public function width($width) { - return $this->setProperty('url', $url); + return $this->setProperty('width', $width); } } diff --git a/src/SportingGoodsStore.php b/src/SportingGoodsStore.php index 0aa6dad09..bc1852251 100644 --- a/src/SportingGoodsStore.php +++ b/src/SportingGoodsStore.php @@ -17,126 +17,104 @@ class SportingGoodsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SportsActivityLocation.php b/src/SportsActivityLocation.php index 36cf0113c..e421b91e9 100644 --- a/src/SportsActivityLocation.php +++ b/src/SportsActivityLocation.php @@ -16,126 +16,104 @@ class SportsActivityLocation extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SportsClub.php b/src/SportsClub.php index cb3923232..733e6eb13 100644 --- a/src/SportsClub.php +++ b/src/SportsClub.php @@ -17,126 +17,104 @@ class SportsClub extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SportsEvent.php b/src/SportsEvent.php index 8234a6fd3..c79b4439d 100644 --- a/src/SportsEvent.php +++ b/src/SportsEvent.php @@ -13,48 +13,6 @@ */ class SportsEvent extends BaseType implements EventContract, ThingContract { - /** - * The away team in a sports event. - * - * @param Person|Person[]|SportsTeam|SportsTeam[] $awayTeam - * - * @return static - * - * @see http://schema.org/awayTeam - */ - public function awayTeam($awayTeam) - { - return $this->setProperty('awayTeam', $awayTeam); - } - - /** - * A competitor in a sports event. - * - * @param Person|Person[]|SportsTeam|SportsTeam[] $competitor - * - * @return static - * - * @see http://schema.org/competitor - */ - public function competitor($competitor) - { - return $this->setProperty('competitor', $competitor); - } - - /** - * The home team in a sports event. - * - * @param Person|Person[]|SportsTeam|SportsTeam[] $homeTeam - * - * @return static - * - * @see http://schema.org/homeTeam - */ - public function homeTeam($homeTeam) - { - return $this->setProperty('homeTeam', $homeTeam); - } - /** * The subject matter of the content. * @@ -85,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -100,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -142,6 +133,34 @@ public function audience($audience) return $this->setProperty('audience', $audience); } + /** + * The away team in a sports event. + * + * @param Person|Person[]|SportsTeam|SportsTeam[] $awayTeam + * + * @return static + * + * @see http://schema.org/awayTeam + */ + public function awayTeam($awayTeam) + { + return $this->setProperty('awayTeam', $awayTeam); + } + + /** + * A competitor in a sports event. + * + * @param Person|Person[]|SportsTeam|SportsTeam[] $competitor + * + * @return static + * + * @see http://schema.org/competitor + */ + public function competitor($competitor) + { + return $this->setProperty('competitor', $competitor); + } + /** * The person or organization who wrote a composition, or who is the * composer of a work performed at some event. @@ -171,6 +190,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -187,6 +220,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -261,6 +311,53 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * The home team in a sports event. + * + * @param Person|Person[]|SportsTeam|SportsTeam[] $homeTeam + * + * @return static + * + * @see http://schema.org/homeTeam + */ + public function homeTeam($homeTeam) + { + return $this->setProperty('homeTeam', $homeTeam); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -307,6 +404,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -321,6 +434,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -381,6 +508,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -441,6 +583,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -503,6 +661,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -549,6 +721,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -580,190 +766,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/SportsOrganization.php b/src/SportsOrganization.php index daafebcd0..c7a7acbb3 100644 --- a/src/SportsOrganization.php +++ b/src/SportsOrganization.php @@ -15,17 +15,22 @@ class SportsOrganization extends BaseType implements OrganizationContract, ThingContract { /** - * A type of sport (e.g. Baseball). + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $sport + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/sport + * @see http://schema.org/additionalType */ - public function sport($sport) + public function additionalType($additionalType) { - return $this->setProperty('sport', $sport); + return $this->setProperty('additionalType', $additionalType); } /** @@ -57,6 +62,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -159,6 +178,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -390,6 +440,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -464,6 +547,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -537,6 +636,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -594,6 +707,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -646,6 +774,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -706,248 +850,104 @@ public function sponsor($sponsor) } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A type of sport (e.g. Baseball). * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sport * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sport */ - public function image($image) + public function sport($sport) { - return $this->setProperty('image', $image); + return $this->setProperty('sport', $sport); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/subOrganization */ - public function mainEntityOfPage($mainEntityOfPage) + public function subOrganization($subOrganization) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('subOrganization', $subOrganization); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param Action|Action[] $potentialAction + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/taxID */ - public function potentialAction($potentialAction) + public function taxID($taxID) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('taxID', $taxID); } /** - * 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. + * The telephone number. * - * @param string|string[] $sameAs + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/telephone */ - public function sameAs($sameAs) + public function telephone($telephone) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('telephone', $telephone); } /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SportsTeam.php b/src/SportsTeam.php index 3d536ff88..dfda2d731 100644 --- a/src/SportsTeam.php +++ b/src/SportsTeam.php @@ -15,89 +15,94 @@ class SportsTeam extends BaseType implements SportsOrganizationContract, OrganizationContract, ThingContract { /** - * A person that acts as performing member of a sports team; a player as - * opposed to a coach. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $athlete + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/athlete + * @see http://schema.org/additionalType */ - public function athlete($athlete) + public function additionalType($additionalType) { - return $this->setProperty('athlete', $athlete); + return $this->setProperty('additionalType', $additionalType); } /** - * A person that acts in a coaching role for a sports team. + * Physical address of the item. * - * @param Person|Person[] $coach + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/coach + * @see http://schema.org/address */ - public function coach($coach) + public function address($address) { - return $this->setProperty('coach', $coach); + return $this->setProperty('address', $address); } /** - * A type of sport (e.g. Baseball). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $sport + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/sport + * @see http://schema.org/aggregateRating */ - public function sport($sport) + public function aggregateRating($aggregateRating) { - return $this->setProperty('sport', $sport); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The geographic area where a service or offered item is provided. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/areaServed */ - public function aggregateRating($aggregateRating) + public function areaServed($areaServed) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('areaServed', $areaServed); } /** - * The geographic area where a service or offered item is provided. + * A person that acts as performing member of a sports team; a player as + * opposed to a coach. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Person|Person[] $athlete * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/athlete */ - public function areaServed($areaServed) + public function athlete($athlete) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('athlete', $athlete); } /** @@ -143,6 +148,20 @@ public function brand($brand) return $this->setProperty('brand', $brand); } + /** + * A person that acts in a coaching role for a sports team. + * + * @param Person|Person[] $coach + * + * @return static + * + * @see http://schema.org/coach + */ + public function coach($coach) + { + return $this->setProperty('coach', $coach); + } + /** * A contact point for a person or organization. * @@ -188,6 +207,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -419,6 +469,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -493,6 +576,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -566,6 +665,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -623,6 +736,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -675,6 +803,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -735,248 +879,104 @@ public function sponsor($sponsor) } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A type of sport (e.g. Baseball). * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sport * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sport */ - public function image($image) + public function sport($sport) { - return $this->setProperty('image', $image); + return $this->setProperty('sport', $sport); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/subOrganization */ - public function mainEntityOfPage($mainEntityOfPage) + public function subOrganization($subOrganization) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('subOrganization', $subOrganization); } /** - * The name of the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $name + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/name + * @see http://schema.org/subjectOf */ - public function name($name) + public function subjectOf($subjectOf) { - return $this->setProperty('name', $name); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param Action|Action[] $potentialAction + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/taxID */ - public function potentialAction($potentialAction) + public function taxID($taxID) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('taxID', $taxID); } /** - * 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. + * The telephone number. * - * @param string|string[] $sameAs + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/telephone */ - public function sameAs($sameAs) + public function telephone($telephone) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('telephone', $telephone); } /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SpreadsheetDigitalDocument.php b/src/SpreadsheetDigitalDocument.php index 83c152f0d..05c33dccd 100644 --- a/src/SpreadsheetDigitalDocument.php +++ b/src/SpreadsheetDigitalDocument.php @@ -14,22 +14,6 @@ */ class SpreadsheetDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract { - /** - * A permission related to the access to this document (e.g. permission to - * read or write an electronic document). For a public document, specify a - * grantee with an Audience with audienceType equal to "public". - * - * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission - * - * @return static - * - * @see http://schema.org/hasDigitalDocumentPermission - */ - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) - { - return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); - } - /** * The subject matter of the content. * @@ -174,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -189,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -480,6 +497,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -676,6 +724,22 @@ public function genre($genre) return $this->setProperty('genre', $genre); } + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + /** * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). @@ -705,6 +769,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -902,6 +999,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -932,6 +1045,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -962,6 +1089,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1103,6 +1245,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1185,6 +1343,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1306,6 +1478,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1349,190 +1535,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/StadiumOrArena.php b/src/StadiumOrArena.php index b54154033..b1b0366b6 100644 --- a/src/StadiumOrArena.php +++ b/src/StadiumOrArena.php @@ -17,35 +17,6 @@ */ class StadiumOrArena extends BaseType implements CivicStructureContract, SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -68,6 +39,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -97,6 +87,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -115,479 +119,495 @@ public function amenityFeature($amenityFeature) } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The geographic area where a service or offered item is provided. * - * @param string|string[] $branchCode + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/areaServed */ - public function branchCode($branchCode) + public function areaServed($areaServed) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('areaServed', $areaServed); } /** - * The basic containment relation between a place and one that contains it. + * An award won by or for this item. * - * @param Place|Place[] $containedIn + * @param string|string[] $award * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/award */ - public function containedIn($containedIn) + public function award($award) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('award', $award); } /** - * The basic containment relation between a place and one that contains it. + * Awards won by or for this item. * - * @param Place|Place[] $containedInPlace + * @param string|string[] $awards * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/awards */ - public function containedInPlace($containedInPlace) + public function awards($awards) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('awards', $awards); } /** - * The basic containment relation between a place and another that it - * contains. + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/branchCode */ - public function containsPlace($containsPlace) + public function branchCode($branchCode) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('branchCode', $branchCode); } /** - * Upcoming or past event associated with this place, organization, or - * action. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param Event|Event[] $event + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/event + * @see http://schema.org/branchOf */ - public function event($event) + public function branchOf($branchOf) { - return $this->setProperty('event', $event); + return $this->setProperty('branchOf', $branchOf); } /** - * Upcoming or past events associated with this place or organization. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param Event|Event[] $events + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/events + * @see http://schema.org/brand */ - public function events($events) + public function brand($brand) { - return $this->setProperty('events', $events); + return $this->setProperty('brand', $brand); } /** - * The fax number. + * A contact point for a person or organization. * - * @param string|string[] $faxNumber + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/faxNumber + * @see http://schema.org/contactPoint */ - public function faxNumber($faxNumber) + public function contactPoint($contactPoint) { - return $this->setProperty('faxNumber', $faxNumber); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The geo coordinates of the place. + * A contact point for a person or organization. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/contactPoints */ - public function geo($geo) + public function contactPoints($contactPoints) { - return $this->setProperty('geo', $geo); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $globalLocationNumber + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/containedIn */ - public function globalLocationNumber($globalLocationNumber) + public function containedIn($containedIn) { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); + return $this->setProperty('containedIn', $containedIn); } /** - * A URL to a map of the place. + * The basic containment relation between a place and one that contains it. * - * @param Map|Map[]|string|string[] $hasMap + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/containedInPlace */ - public function hasMap($hasMap) + public function containedInPlace($containedInPlace) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The basic containment relation between a place and another that it + * contains. * - * @param bool|bool[] $isAccessibleForFree + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/containsPlace */ - public function isAccessibleForFree($isAccessibleForFree) + public function containsPlace($containsPlace) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $isicV4 + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/currenciesAccepted */ - public function isicV4($isicV4) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/department */ - public function latitude($latitude) + public function department($department) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('department', $department); } /** - * An associated logo. + * A description of the item. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param string|string[] $description * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/description */ - public function logo($logo) + public function description($description) { - return $this->setProperty('logo', $logo); + return $this->setProperty('description', $description); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * 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. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/disambiguatingDescription */ - public function longitude($longitude) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * A URL to a map of the place. + * The date that this organization was dissolved. * - * @param string|string[] $map + * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate * * @return static * - * @see http://schema.org/map + * @see http://schema.org/dissolutionDate */ - public function map($map) + public function dissolutionDate($dissolutionDate) { - return $this->setProperty('map', $map); + return $this->setProperty('dissolutionDate', $dissolutionDate); } /** - * A URL to a map of the place. + * The Dun & Bradstreet DUNS number for identifying an organization or + * business person. * - * @param string|string[] $maps + * @param string|string[] $duns * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/duns */ - public function maps($maps) + public function duns($duns) { - return $this->setProperty('maps', $maps); + return $this->setProperty('duns', $duns); } /** - * The total number of individuals that may attend an event or venue. + * Email address. * - * @param int|int[] $maximumAttendeeCapacity + * @param string|string[] $email * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/email */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function email($email) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('email', $email); } /** - * The opening hours of a certain place. + * Someone working for this organization. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Person|Person[] $employee * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/employee */ - public function openingHoursSpecification($openingHoursSpecification) + public function employee($employee) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('employee', $employee); } /** - * A photograph of this place. + * People working for this organization. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param Person|Person[] $employees * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/employees */ - public function photo($photo) + public function employees($employees) { - return $this->setProperty('photo', $photo); + return $this->setProperty('employees', $employees); } /** - * Photographs of this place. + * Upcoming or past event associated with this place, organization, or + * action. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param Event|Event[] $event * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/event */ - public function photos($photos) + public function event($event) { - return $this->setProperty('photos', $photos); + return $this->setProperty('event', $event); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * Upcoming or past events associated with this place or organization. * - * @param bool|bool[] $publicAccess + * @param Event|Event[] $events * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/events */ - public function publicAccess($publicAccess) + public function events($events) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('events', $events); } /** - * A review of the item. + * The fax number. * - * @param Review|Review[] $review + * @param string|string[] $faxNumber * * @return static * - * @see http://schema.org/review + * @see http://schema.org/faxNumber */ - public function review($review) + public function faxNumber($faxNumber) { - return $this->setProperty('review', $review); + return $this->setProperty('faxNumber', $faxNumber); } /** - * Review of the item. + * A person who founded this organization. * - * @param Review|Review[] $reviews + * @param Person|Person[] $founder * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/founder */ - public function reviews($reviews) + public function founder($founder) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('founder', $founder); } /** - * A slogan or motto associated with the item. + * A person who founded this organization. * - * @param string|string[] $slogan + * @param Person|Person[] $founders * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/founders */ - public function slogan($slogan) + public function founders($founders) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('founders', $founders); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * The date that this organization was founded. * - * @param bool|bool[] $smokingAllowed + * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/foundingDate */ - public function smokingAllowed($smokingAllowed) + public function foundingDate($foundingDate) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('foundingDate', $foundingDate); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The place where the Organization was founded. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param Place|Place[] $foundingLocation * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/foundingLocation */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function foundingLocation($foundingLocation) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('foundingLocation', $foundingLocation); } /** - * The telephone number. + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $funder * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/funder */ - public function telephone($telephone) + public function funder($funder) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('funder', $funder); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The geo coordinates of the place. * - * @param string|string[] $additionalType + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/geo */ - public function additionalType($additionalType) + public function geo($geo) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('geo', $geo); } /** - * An alias for the item. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $alternateName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/globalLocationNumber */ - public function alternateName($alternateName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * A description of the item. + * A URL to a map of the place. * - * @param string|string[] $description + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/description + * @see http://schema.org/hasMap */ - public function description($description) + public function hasMap($hasMap) { - return $this->setProperty('description', $description); + return $this->setProperty('hasMap', $hasMap); } /** - * 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. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param string|string[] $disambiguatingDescription + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/hasOfferCatalog */ - public function disambiguatingDescription($disambiguatingDescription) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + } + + /** + * Points-of-Sales operated by the organization or person. + * + * @param Place|Place[] $hasPOS + * + * @return static + * + * @see http://schema.org/hasPOS + */ + public function hasPOS($hasPOS) + { + return $this->setProperty('hasPOS', $hasPOS); } /** @@ -624,657 +644,595 @@ public function image($image) } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A flag to signal that the item, event, or place is accessible for free. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/isAccessibleForFree */ - public function mainEntityOfPage($mainEntityOfPage) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The name of the item. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $name + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/name + * @see http://schema.org/isicV4 */ - public function name($name) + public function isicV4($isicV4) { - return $this->setProperty('name', $name); + return $this->setProperty('isicV4', $isicV4); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Action|Action[] $potentialAction + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/latitude */ - public function potentialAction($potentialAction) + public function latitude($latitude) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('latitude', $latitude); } /** - * 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. + * The official name of the organization, e.g. the registered company name. * - * @param string|string[] $sameAs + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/legalName */ - public function sameAs($sameAs) + public function legalName($legalName) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('legalName', $legalName); } /** - * A CreativeWork or Event about this Thing. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/leiCode */ - public function subjectOf($subjectOf) + public function leiCode($leiCode) { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $currenciesAccepted - * - * @return static - * - * @see http://schema.org/currenciesAccepted - */ - public function currenciesAccepted($currenciesAccepted) - { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); - } - - /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. - * - * @param string|string[] $paymentAccepted - * - * @return static - * - * @see http://schema.org/paymentAccepted - */ - public function paymentAccepted($paymentAccepted) - { - return $this->setProperty('paymentAccepted', $paymentAccepted); - } - - /** - * The price range of the business, for example ```$$$```. - * - * @param string|string[] $priceRange - * - * @return static - * - * @see http://schema.org/priceRange - */ - public function priceRange($priceRange) - { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('leiCode', $leiCode); } /** - * The geographic area where a service or offered item is provided. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/location */ - public function areaServed($areaServed) + public function location($location) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('location', $location); } /** - * An award won by or for this item. + * An associated logo. * - * @param string|string[] $award + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/award + * @see http://schema.org/logo */ - public function award($award) + public function logo($logo) { - return $this->setProperty('award', $award); + return $this->setProperty('logo', $logo); } /** - * Awards won by or for this item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param string|string[] $awards + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/longitude */ - public function awards($awards) + public function longitude($longitude) { - return $this->setProperty('awards', $awards); + return $this->setProperty('longitude', $longitude); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/mainEntityOfPage */ - public function brand($brand) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('brand', $brand); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A contact point for a person or organization. + * A pointer to products or services offered by the organization or person. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/makesOffer */ - public function contactPoint($contactPoint) + public function makesOffer($makesOffer) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('makesOffer', $makesOffer); } /** - * A contact point for a person or organization. + * A URL to a map of the place. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $map * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/map */ - public function contactPoints($contactPoints) + public function map($map) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('map', $map); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * A URL to a map of the place. * - * @param Organization|Organization[] $department + * @param string|string[] $maps * * @return static * - * @see http://schema.org/department + * @see http://schema.org/maps */ - public function department($department) + public function maps($maps) { - return $this->setProperty('department', $department); + return $this->setProperty('maps', $maps); } /** - * The date that this organization was dissolved. + * The total number of individuals that may attend an event or venue. * - * @param \DateTimeInterface|\DateTimeInterface[] $dissolutionDate + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/dissolutionDate + * @see http://schema.org/maximumAttendeeCapacity */ - public function dissolutionDate($dissolutionDate) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('dissolutionDate', $dissolutionDate); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * The Dun & Bradstreet DUNS number for identifying an organization or - * business person. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param string|string[] $duns + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/duns + * @see http://schema.org/member */ - public function duns($duns) + public function member($member) { - return $this->setProperty('duns', $duns); + return $this->setProperty('member', $member); } /** - * Email address. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $email + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/email + * @see http://schema.org/memberOf */ - public function email($email) + public function memberOf($memberOf) { - return $this->setProperty('email', $email); + return $this->setProperty('memberOf', $memberOf); } /** - * Someone working for this organization. + * A member of this organization. * - * @param Person|Person[] $employee + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/employee + * @see http://schema.org/members */ - public function employee($employee) + public function members($members) { - return $this->setProperty('employee', $employee); + return $this->setProperty('members', $members); } /** - * People working for this organization. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param Person|Person[] $employees + * @param string|string[] $naics * * @return static * - * @see http://schema.org/employees + * @see http://schema.org/naics */ - public function employees($employees) + public function naics($naics) { - return $this->setProperty('employees', $employees); + return $this->setProperty('naics', $naics); } /** - * A person who founded this organization. + * The name of the item. * - * @param Person|Person[] $founder + * @param string|string[] $name * * @return static * - * @see http://schema.org/founder + * @see http://schema.org/name */ - public function founder($founder) + public function name($name) { - return $this->setProperty('founder', $founder); + return $this->setProperty('name', $name); } /** - * A person who founded this organization. + * The number of employees in an organization e.g. business. * - * @param Person|Person[] $founders + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/founders + * @see http://schema.org/numberOfEmployees */ - public function founders($founders) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('founders', $founders); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * The date that this organization was founded. + * A pointer to the organization or person making the offer. * - * @param \DateTimeInterface|\DateTimeInterface[] $foundingDate + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/foundingDate + * @see http://schema.org/offeredBy */ - public function foundingDate($foundingDate) + public function offeredBy($offeredBy) { - return $this->setProperty('foundingDate', $foundingDate); + return $this->setProperty('offeredBy', $offeredBy); } /** - * The place where the Organization was founded. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param Place|Place[] $foundingLocation + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/foundingLocation + * @see http://schema.org/openingHours */ - public function foundingLocation($foundingLocation) + public function openingHours($openingHours) { - return $this->setProperty('foundingLocation', $foundingLocation); + return $this->setProperty('openingHours', $openingHours); } /** - * A person or organization that supports (sponsors) something through some - * kind of financial contribution. + * The opening hours of a certain place. * - * @param Organization|Organization[]|Person|Person[] $funder + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/funder + * @see http://schema.org/openingHoursSpecification */ - public function funder($funder) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('funder', $funder); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. + * Products owned by the organization or person. * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/hasOfferCatalog + * @see http://schema.org/owns */ - public function hasOfferCatalog($hasOfferCatalog) + public function owns($owns) { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); + return $this->setProperty('owns', $owns); } /** - * Points-of-Sales operated by the organization or person. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param Place|Place[] $hasPOS + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/hasPOS + * @see http://schema.org/parentOrganization */ - public function hasPOS($hasPOS) + public function parentOrganization($parentOrganization) { - return $this->setProperty('hasPOS', $hasPOS); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * The official name of the organization, e.g. the registered company name. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param string|string[] $legalName + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/paymentAccepted */ - public function legalName($legalName) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A photograph of this place. * - * @param string|string[] $leiCode + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/photo */ - public function leiCode($leiCode) + public function photo($photo) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('photo', $photo); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Photographs of this place. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/location + * @see http://schema.org/photos */ - public function location($location) + public function photos($photos) { - return $this->setProperty('location', $location); + return $this->setProperty('photos', $photos); } /** - * A pointer to products or services offered by the organization or person. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Offer|Offer[] $makesOffer + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/potentialAction */ - public function makesOffer($makesOffer) + public function potentialAction($potentialAction) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * The price range of the business, for example ```$$$```. * - * @param Organization|Organization[]|Person|Person[] $member + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/member + * @see http://schema.org/priceRange */ - public function member($member) + public function priceRange($priceRange) { - return $this->setProperty('member', $member); + return $this->setProperty('priceRange', $priceRange); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/publicAccess */ - public function memberOf($memberOf) + public function publicAccess($publicAccess) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A member of this organization. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Organization|Organization[]|Person|Person[] $members + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/members + * @see http://schema.org/publishingPrinciples */ - public function members($members) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('members', $members); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * A review of the item. * - * @param string|string[] $naics + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/review */ - public function naics($naics) + public function review($review) { - return $this->setProperty('naics', $naics); + return $this->setProperty('review', $review); } /** - * The number of employees in an organization e.g. business. + * Review of the item. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/reviews */ - public function numberOfEmployees($numberOfEmployees) + public function reviews($reviews) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('reviews', $reviews); } /** - * A pointer to the organization or person making the offer. + * 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. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/sameAs */ - public function offeredBy($offeredBy) + public function sameAs($sameAs) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('sameAs', $sameAs); } /** - * Products owned by the organization or person. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/seeks */ - public function owns($owns) + public function seeks($seeks) { - return $this->setProperty('owns', $owns); + return $this->setProperty('seeks', $seeks); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The geographic area where the service is provided. * - * @param Organization|Organization[] $parentOrganization + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/serviceArea */ - public function parentOrganization($parentOrganization) + public function serviceArea($serviceArea) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('serviceArea', $serviceArea); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/slogan */ - public function publishingPrinciples($publishingPrinciples) + public function slogan($slogan) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('slogan', $slogan); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param Demand|Demand[] $seeks + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/smokingAllowed */ - public function seeks($seeks) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * The geographic area where the service is provided. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/specialOpeningHoursSpecification */ - public function serviceArea($serviceArea) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** @@ -1309,6 +1267,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -1324,6 +1296,34 @@ public function taxID($taxID) return $this->setProperty('taxID', $taxID); } + /** + * The telephone number. + * + * @param string|string[] $telephone + * + * @return static + * + * @see http://schema.org/telephone + */ + public function telephone($telephone) + { + return $this->setProperty('telephone', $telephone); + } + + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The Value-added Tax ID of the organization or person. * diff --git a/src/State.php b/src/State.php index 398776517..00e682738 100644 --- a/src/State.php +++ b/src/State.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/SteeringPositionValue.php b/src/SteeringPositionValue.php index 7a3bdae48..4cd9c89a3 100644 --- a/src/SteeringPositionValue.php +++ b/src/SteeringPositionValue.php @@ -54,205 +54,175 @@ public function additionalProperty($additionalProperty) } /** - * This ordering relation for qualitative values indicates that the subject - * is equal to the object. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QualitativeValue|QualitativeValue[] $equal + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/equal + * @see http://schema.org/additionalType */ - public function equal($equal) + public function additionalType($additionalType) { - return $this->setProperty('equal', $equal); + return $this->setProperty('additionalType', $additionalType); } /** - * This ordering relation for qualitative values indicates that the subject - * is greater than the object. + * An alias for the item. * - * @param QualitativeValue|QualitativeValue[] $greater + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/greater + * @see http://schema.org/alternateName */ - public function greater($greater) + public function alternateName($alternateName) { - return $this->setProperty('greater', $greater); + return $this->setProperty('alternateName', $alternateName); } /** - * This ordering relation for qualitative values indicates that the subject - * is greater than or equal to the object. + * A description of the item. * - * @param QualitativeValue|QualitativeValue[] $greaterOrEqual + * @param string|string[] $description * * @return static * - * @see http://schema.org/greaterOrEqual + * @see http://schema.org/description */ - public function greaterOrEqual($greaterOrEqual) + public function description($description) { - return $this->setProperty('greaterOrEqual', $greaterOrEqual); + return $this->setProperty('description', $description); } /** - * This ordering relation for qualitative values indicates that the subject - * is lesser than the object. + * 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. * - * @param QualitativeValue|QualitativeValue[] $lesser + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/lesser + * @see http://schema.org/disambiguatingDescription */ - public function lesser($lesser) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('lesser', $lesser); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** * This ordering relation for qualitative values indicates that the subject - * is lesser than or equal to the object. + * is equal to the object. * - * @param QualitativeValue|QualitativeValue[] $lesserOrEqual + * @param QualitativeValue|QualitativeValue[] $equal * * @return static * - * @see http://schema.org/lesserOrEqual + * @see http://schema.org/equal */ - public function lesserOrEqual($lesserOrEqual) + public function equal($equal) { - return $this->setProperty('lesserOrEqual', $lesserOrEqual); + return $this->setProperty('equal', $equal); } /** * This ordering relation for qualitative values indicates that the subject - * is not equal to the object. - * - * @param QualitativeValue|QualitativeValue[] $nonEqual - * - * @return static - * - * @see http://schema.org/nonEqual - */ - public function nonEqual($nonEqual) - { - return $this->setProperty('nonEqual', $nonEqual); - } - - /** - * A pointer to a secondary value that provides additional information on - * the original value, e.g. a reference temperature. - * - * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference - * - * @return static - * - * @see http://schema.org/valueReference - */ - public function valueReference($valueReference) - { - return $this->setProperty('valueReference', $valueReference); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * is greater than the object. * - * @param string|string[] $additionalType + * @param QualitativeValue|QualitativeValue[] $greater * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/greater */ - public function additionalType($additionalType) + public function greater($greater) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('greater', $greater); } /** - * An alias for the item. + * This ordering relation for qualitative values indicates that the subject + * is greater than or equal to the object. * - * @param string|string[] $alternateName + * @param QualitativeValue|QualitativeValue[] $greaterOrEqual * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/greaterOrEqual */ - public function alternateName($alternateName) + public function greaterOrEqual($greaterOrEqual) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('greaterOrEqual', $greaterOrEqual); } /** - * A description of the item. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $description + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/description + * @see http://schema.org/identifier */ - public function description($description) + public function identifier($identifier) { - return $this->setProperty('description', $description); + return $this->setProperty('identifier', $identifier); } /** - * 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. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $disambiguatingDescription + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/image */ - public function disambiguatingDescription($disambiguatingDescription) + public function image($image) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('image', $image); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * This ordering relation for qualitative values indicates that the subject + * is lesser than the object. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param QualitativeValue|QualitativeValue[] $lesser * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/lesser */ - public function identifier($identifier) + public function lesser($lesser) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('lesser', $lesser); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * This ordering relation for qualitative values indicates that the subject + * is lesser than or equal to the object. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param QualitativeValue|QualitativeValue[] $lesserOrEqual * * @return static * - * @see http://schema.org/image + * @see http://schema.org/lesserOrEqual */ - public function image($image) + public function lesserOrEqual($lesserOrEqual) { - return $this->setProperty('image', $image); + return $this->setProperty('lesserOrEqual', $lesserOrEqual); } /** @@ -285,6 +255,21 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * This ordering relation for qualitative values indicates that the subject + * is not equal to the object. + * + * @param QualitativeValue|QualitativeValue[] $nonEqual + * + * @return static + * + * @see http://schema.org/nonEqual + */ + public function nonEqual($nonEqual) + { + return $this->setProperty('nonEqual', $nonEqual); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -344,4 +329,19 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * A pointer to a secondary value that provides additional information on + * the original value, e.g. a reference temperature. + * + * @param Enumeration|Enumeration[]|PropertyValue|PropertyValue[]|QualitativeValue|QualitativeValue[]|QuantitativeValue|QuantitativeValue[]|StructuredValue|StructuredValue[] $valueReference + * + * @return static + * + * @see http://schema.org/valueReference + */ + public function valueReference($valueReference) + { + return $this->setProperty('valueReference', $valueReference); + } + } diff --git a/src/Store.php b/src/Store.php index 8a179eeb4..2fbc0d243 100644 --- a/src/Store.php +++ b/src/Store.php @@ -16,126 +16,104 @@ class Store extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/SubscribeAction.php b/src/SubscribeAction.php index f621bd314..9af187da9 100644 --- a/src/SubscribeAction.php +++ b/src/SubscribeAction.php @@ -40,340 +40,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/SubwayStation.php b/src/SubwayStation.php index 41c841dba..a5d93f86e 100644 --- a/src/SubwayStation.php +++ b/src/SubwayStation.php @@ -14,35 +14,6 @@ */ class SubwayStation extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/Suite.php b/src/Suite.php index 2b5c1cda4..fc40746b7 100644 --- a/src/Suite.php +++ b/src/Suite.php @@ -21,186 +21,122 @@ class Suite extends BaseType implements AccommodationContract, PlaceContract, ThingContract { /** - * The type of bed or beds included in the accommodation. For the single - * case of just one bed of a certain type, you use bed directly with a text. - * If you want to indicate the quantity of a certain kind of bed, use - * an instance of BedDetails. For more detailed information, use the - * amenityFeature property. - * - * @param BedDetails|BedDetails[]|string|string[] $bed - * - * @return static - * - * @see http://schema.org/bed - */ - public function bed($bed) - { - return $this->setProperty('bed', $bed); - } - - /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms - * - * @return static - * - * @see http://schema.org/numberOfRooms - */ - public function numberOfRooms($numberOfRooms) - { - return $this->setProperty('numberOfRooms', $numberOfRooms); - } - - /** - * The allowed total occupancy for the accommodation in persons (including - * infants etc). For individual accommodations, this is not necessarily the - * legal maximum but defines the permitted usage as per the contractual - * agreement (e.g. a double room used by a single person). - * Typical unit code(s): C62 for person - * - * @param QuantitativeValue|QuantitativeValue[] $occupancy - * - * @return static - * - * @see http://schema.org/occupancy - */ - public function occupancy($occupancy) - { - return $this->setProperty('occupancy', $occupancy); - } - - /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. - * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature - * - * @return static - * - * @see http://schema.org/amenityFeature - */ - public function amenityFeature($amenityFeature) - { - return $this->setProperty('amenityFeature', $amenityFeature); - } - - /** - * The size of the accommodation, e.g. in square meter or squarefoot. - * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK - * for square yard + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[] $floorSize + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/floorSize + * @see http://schema.org/additionalProperty */ - public function floorSize($floorSize) + public function additionalProperty($additionalProperty) { - return $this->setProperty('floorSize', $floorSize); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The number of rooms (excluding bathrooms and closets) of the - * accommodation or lodging business. - * Typical unit code(s): ROM for room or C62 for no unit. The type of room - * can be put in the unitText property of the QuantitativeValue. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/numberOfRooms + * @see http://schema.org/additionalType */ - public function numberOfRooms($numberOfRooms) + public function additionalType($additionalType) { - return $this->setProperty('numberOfRooms', $numberOfRooms); + return $this->setProperty('additionalType', $additionalType); } /** - * Indications regarding the permitted usage of the accommodation. + * Physical address of the item. * - * @param string|string[] $permittedUsage + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/permittedUsage + * @see http://schema.org/address */ - public function permittedUsage($permittedUsage) + public function address($address) { - return $this->setProperty('permittedUsage', $permittedUsage); + return $this->setProperty('address', $address); } /** - * Indicates whether pets are allowed to enter the accommodation or lodging - * business. More detailed information can be put in a text value. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param bool|bool[]|string|string[] $petsAllowed + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/petsAllowed + * @see http://schema.org/aggregateRating */ - public function petsAllowed($petsAllowed) + public function aggregateRating($aggregateRating) { - return $this->setProperty('petsAllowed', $petsAllowed); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * An alias for the item. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/alternateName */ - public function additionalProperty($additionalProperty) + public function alternateName($alternateName) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('alternateName', $alternateName); } /** - * Physical address of the item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/address + * @see http://schema.org/amenityFeature */ - public function address($address) + public function amenityFeature($amenityFeature) { - return $this->setProperty('address', $address); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The type of bed or beds included in the accommodation. For the single + * case of just one bed of a certain type, you use bed directly with a text. + * If you want to indicate the quantity of a certain kind of bed, use + * an instance of BedDetails. For more detailed information, use the + * amenityFeature property. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param BedDetails|BedDetails[]|string|string[] $bed * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/bed */ - public function aggregateRating($aggregateRating) + public function bed($bed) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('bed', $bed); } /** @@ -266,6 +202,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -309,6 +276,22 @@ public function faxNumber($faxNumber) return $this->setProperty('faxNumber', $faxNumber); } + /** + * The size of the accommodation, e.g. in square meter or squarefoot. + * Typical unit code(s): MTK for square meter, FTK for square foot, or YDK + * for square yard + * + * @param QuantitativeValue|QuantitativeValue[] $floorSize + * + * @return static + * + * @see http://schema.org/floorSize + */ + public function floorSize($floorSize) + { + return $this->setProperty('floorSize', $floorSize); + } + /** * The geo coordinates of the place. * @@ -354,6 +337,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -428,6 +444,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -471,320 +503,271 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) } /** - * The opening hours of a certain place. - * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification - * - * @return static - * - * @see http://schema.org/openingHoursSpecification - */ - public function openingHoursSpecification($openingHoursSpecification) - { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); - } - - /** - * A photograph of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo - * - * @return static - * - * @see http://schema.org/photo - */ - public function photo($photo) - { - return $this->setProperty('photo', $photo); - } - - /** - * Photographs of this place. - * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos - * - * @return static - * - * @see http://schema.org/photos - */ - public function photos($photos) - { - return $this->setProperty('photos', $photos); - } - - /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The name of the item. * - * @param bool|bool[] $publicAccess + * @param string|string[] $name * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/name */ - public function publicAccess($publicAccess) + public function name($name) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('name', $name); } /** - * A review of the item. + * The number of rooms (excluding bathrooms and closets) of the + * accommodation or lodging business. + * Typical unit code(s): ROM for room or C62 for no unit. The type of room + * can be put in the unitText property of the QuantitativeValue. * - * @param Review|Review[] $review + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfRooms * * @return static * - * @see http://schema.org/review + * @see http://schema.org/numberOfRooms */ - public function review($review) + public function numberOfRooms($numberOfRooms) { - return $this->setProperty('review', $review); + return $this->setProperty('numberOfRooms', $numberOfRooms); } /** - * Review of the item. + * The allowed total occupancy for the accommodation in persons (including + * infants etc). For individual accommodations, this is not necessarily the + * legal maximum but defines the permitted usage as per the contractual + * agreement (e.g. a double room used by a single person). + * Typical unit code(s): C62 for person * - * @param Review|Review[] $reviews + * @param QuantitativeValue|QuantitativeValue[] $occupancy * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/occupancy */ - public function reviews($reviews) + public function occupancy($occupancy) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('occupancy', $occupancy); } /** - * A slogan or motto associated with the item. + * The opening hours of a certain place. * - * @param string|string[] $slogan + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/openingHoursSpecification */ - public function slogan($slogan) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * Indications regarding the permitted usage of the accommodation. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $permittedUsage * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/permittedUsage */ - public function smokingAllowed($smokingAllowed) + public function permittedUsage($permittedUsage) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('permittedUsage', $permittedUsage); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * Indicates whether pets are allowed to enter the accommodation or lodging + * business. More detailed information can be put in a text value. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param bool|bool[]|string|string[] $petsAllowed * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/petsAllowed */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function petsAllowed($petsAllowed) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('petsAllowed', $petsAllowed); } /** - * The telephone number. + * A photograph of this place. * - * @param string|string[] $telephone + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/photo */ - public function telephone($telephone) + public function photo($photo) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('photo', $photo); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Photographs of this place. * - * @param string|string[] $additionalType + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/photos */ - public function additionalType($additionalType) + public function photos($photos) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('photos', $photos); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param string|string[] $description + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/description + * @see http://schema.org/publicAccess */ - public function description($description) + public function publicAccess($publicAccess) { - return $this->setProperty('description', $description); + return $this->setProperty('publicAccess', $publicAccess); } /** - * 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. + * A review of the item. * - * @param string|string[] $disambiguatingDescription + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/review */ - public function disambiguatingDescription($disambiguatingDescription) + public function review($review) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('review', $review); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Review of the item. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reviews */ - public function identifier($identifier) + public function reviews($reviews) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reviews', $reviews); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * 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. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/image + * @see http://schema.org/sameAs */ - public function image($image) + public function sameAs($sameAs) { - return $this->setProperty('image', $image); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A slogan or motto associated with the item. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/slogan */ - public function mainEntityOfPage($mainEntityOfPage) + public function slogan($slogan) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('slogan', $slogan); } /** - * The name of the item. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $name + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/name + * @see http://schema.org/smokingAllowed */ - public function name($name) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('name', $name); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param Action|Action[] $potentialAction + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/specialOpeningHoursSpecification */ - public function potentialAction($potentialAction) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/SuspendAction.php b/src/SuspendAction.php index ff910e5b2..27e129d68 100644 --- a/src/SuspendAction.php +++ b/src/SuspendAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Synagogue.php b/src/Synagogue.php index 1a18405f1..49e1529eb 100644 --- a/src/Synagogue.php +++ b/src/Synagogue.php @@ -15,35 +15,6 @@ */ class Synagogue extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -66,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -95,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -175,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -263,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -337,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -379,6 +463,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -421,6 +548,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -464,6 +606,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -511,189 +669,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/TVClip.php b/src/TVClip.php index ae935efed..65a385190 100644 --- a/src/TVClip.php +++ b/src/TVClip.php @@ -14,152 +14,6 @@ */ class TVClip extends BaseType implements ClipContract, CreativeWorkContract, ThingContract { - /** - * The TV series to which this episode or season belongs. - * - * @param TVSeries|TVSeries[] $partOfTVSeries - * - * @return static - * - * @see http://schema.org/partOfTVSeries - */ - public function partOfTVSeries($partOfTVSeries) - { - return $this->setProperty('partOfTVSeries', $partOfTVSeries); - } - - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * Position of the clip within an ordered group of clips. - * - * @param int|int[]|string|string[] $clipNumber - * - * @return static - * - * @see http://schema.org/clipNumber - */ - public function clipNumber($clipNumber) - { - return $this->setProperty('clipNumber', $clipNumber); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The episode to which this clip belongs. - * - * @param Episode|Episode[] $partOfEpisode - * - * @return static - * - * @see http://schema.org/partOfEpisode - */ - public function partOfEpisode($partOfEpisode) - { - return $this->setProperty('partOfEpisode', $partOfEpisode); - } - - /** - * The season to which this episode belongs. - * - * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason - * - * @return static - * - * @see http://schema.org/partOfSeason - */ - public function partOfSeason($partOfSeason) - { - return $this->setProperty('partOfSeason', $partOfSeason); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - /** * The subject matter of the content. * @@ -304,6 +158,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -319,6 +223,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -449,6 +367,20 @@ public function citation($citation) return $this->setProperty('citation', $citation); } + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + /** * Comments, typically from users. * @@ -611,45 +543,107 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); } /** @@ -835,6 +829,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1032,6 +1059,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1062,6 +1105,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1078,6 +1149,62 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The TV series to which this episode or season belongs. + * + * @param TVSeries|TVSeries[] $partOfTVSeries + * + * @return static + * + * @see http://schema.org/partOfTVSeries + */ + public function partOfTVSeries($partOfTVSeries) + { + return $this->setProperty('partOfTVSeries', $partOfTVSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1092,6 +1219,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1233,6 +1375,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1315,6 +1473,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1436,6 +1608,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1479,190 +1665,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/TVEpisode.php b/src/TVEpisode.php index 2aef46b6f..fbfcd0249 100644 --- a/src/TVEpisode.php +++ b/src/TVEpisode.php @@ -14,197 +14,6 @@ */ class TVEpisode extends BaseType implements EpisodeContract, CreativeWorkContract, ThingContract { - /** - * The country of the principal offices of the production company or - * individual responsible for the movie or program. - * - * @param Country|Country[] $countryOfOrigin - * - * @return static - * - * @see http://schema.org/countryOfOrigin - */ - public function countryOfOrigin($countryOfOrigin) - { - return $this->setProperty('countryOfOrigin', $countryOfOrigin); - } - - /** - * The TV series to which this episode or season belongs. - * - * @param TVSeries|TVSeries[] $partOfTVSeries - * - * @return static - * - * @see http://schema.org/partOfTVSeries - */ - public function partOfTVSeries($partOfTVSeries) - { - return $this->setProperty('partOfTVSeries', $partOfTVSeries); - } - - /** - * Languages in which subtitles/captions are available, in [IETF BCP 47 - * standard format](http://tools.ietf.org/html/bcp47). - * - * @param Language|Language[]|string|string[] $subtitleLanguage - * - * @return static - * - * @see http://schema.org/subtitleLanguage - */ - public function subtitleLanguage($subtitleLanguage) - { - return $this->setProperty('subtitleLanguage', $subtitleLanguage); - } - - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * Position of the episode within an ordered group of episodes. - * - * @param int|int[]|string|string[] $episodeNumber - * - * @return static - * - * @see http://schema.org/episodeNumber - */ - public function episodeNumber($episodeNumber) - { - return $this->setProperty('episodeNumber', $episodeNumber); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The season to which this episode belongs. - * - * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason - * - * @return static - * - * @see http://schema.org/partOfSeason - */ - public function partOfSeason($partOfSeason) - { - return $this->setProperty('partOfSeason', $partOfSeason); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The trailer of a movie or tv/radio series, season, episode, etc. - * - * @param VideoObject|VideoObject[] $trailer - * - * @return static - * - * @see http://schema.org/trailer - */ - public function trailer($trailer) - { - return $this->setProperty('trailer', $trailer); - } - /** * The subject matter of the content. * @@ -349,6 +158,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -364,6 +223,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -597,7 +470,22 @@ public function copyrightYear($copyrightYear) } /** - * The creator/author of this CreativeWork. This is the same as the Author + * The country of the principal offices of the production company or + * individual responsible for the movie or program. + * + * @param Country|Country[] $countryOfOrigin + * + * @return static + * + * @see http://schema.org/countryOfOrigin + */ + public function countryOfOrigin($countryOfOrigin) + { + return $this->setProperty('countryOfOrigin', $countryOfOrigin); + } + + /** + * The creator/author of this CreativeWork. This is the same as the Author * property for CreativeWork. * * @param Organization|Organization[]|Person|Person[] $creator @@ -655,6 +543,68 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -768,6 +718,20 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * Position of the episode within an ordered group of episodes. + * + * @param int|int[]|string|string[] $episodeNumber + * + * @return static + * + * @see http://schema.org/episodeNumber + */ + public function episodeNumber($episodeNumber) + { + return $this->setProperty('episodeNumber', $episodeNumber); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -880,6 +844,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1077,6 +1074,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1107,6 +1120,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1123,6 +1164,48 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The TV series to which this episode or season belongs. + * + * @param TVSeries|TVSeries[] $partOfTVSeries + * + * @return static + * + * @see http://schema.org/partOfTVSeries + */ + public function partOfTVSeries($partOfTVSeries) + { + return $this->setProperty('partOfTVSeries', $partOfTVSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1137,6 +1220,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1152,6 +1250,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1278,6 +1391,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1360,6 +1489,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Languages in which subtitles/captions are available, in [IETF BCP 47 + * standard format](http://tools.ietf.org/html/bcp47). + * + * @param Language|Language[]|string|string[] $subtitleLanguage + * + * @return static + * + * @see http://schema.org/subtitleLanguage + */ + public function subtitleLanguage($subtitleLanguage) + { + return $this->setProperty('subtitleLanguage', $subtitleLanguage); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1451,6 +1609,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1481,6 +1653,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1524,190 +1710,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/TVSeason.php b/src/TVSeason.php index d137c2489..4f5186e90 100644 --- a/src/TVSeason.php +++ b/src/TVSeason.php @@ -15,35 +15,6 @@ */ class TVSeason extends BaseType implements CreativeWorkContract, CreativeWorkSeasonContract, CreativeWorkContract, ThingContract { - /** - * The country of the principal offices of the production company or - * individual responsible for the movie or program. - * - * @param Country|Country[] $countryOfOrigin - * - * @return static - * - * @see http://schema.org/countryOfOrigin - */ - public function countryOfOrigin($countryOfOrigin) - { - return $this->setProperty('countryOfOrigin', $countryOfOrigin); - } - - /** - * The TV series to which this episode or season belongs. - * - * @param TVSeries|TVSeries[] $partOfTVSeries - * - * @return static - * - * @see http://schema.org/partOfTVSeries - */ - public function partOfTVSeries($partOfTVSeries) - { - return $this->setProperty('partOfTVSeries', $partOfTVSeries); - } - /** * The subject matter of the content. * @@ -188,6 +159,41 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -203,6 +209,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -435,6 +455,21 @@ public function copyrightYear($copyrightYear) return $this->setProperty('copyrightYear', $copyrightYear); } + /** + * The country of the principal offices of the production company or + * individual responsible for the movie or program. + * + * @param Country|Country[] $countryOfOrigin + * + * @return static + * + * @see http://schema.org/countryOfOrigin + */ + public function countryOfOrigin($countryOfOrigin) + { + return $this->setProperty('countryOfOrigin', $countryOfOrigin); + } + /** * The creator/author of this CreativeWork. This is the same as the Author * property for CreativeWork. @@ -494,6 +529,53 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -607,6 +689,49 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An episode of a tv, radio or game media within a series or season. + * + * @param Episode|Episode[] $episode + * + * @return static + * + * @see http://schema.org/episode + */ + public function episode($episode) + { + return $this->setProperty('episode', $episode); + } + + /** + * An episode of a TV/radio series or season. + * + * @param Episode|Episode[] $episodes + * + * @return static + * + * @see http://schema.org/episodes + */ + public function episodes($episodes) + { + return $this->setProperty('episodes', $episodes); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -719,6 +844,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -916,6 +1074,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -947,38 +1121,109 @@ public function mentions($mentions) } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * The name of the item. * - * @param Offer|Offer[] $offers + * @param string|string[] $name * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/name */ - public function offers($offers) + public function name($name) { - return $this->setProperty('offers', $offers); + return $this->setProperty('name', $name); } /** - * The position of an item in a series or sequence of items. + * The number of episodes in this season or series. * - * @param int|int[]|string|string[] $position + * @param int|int[] $numberOfEpisodes * * @return static * - * @see http://schema.org/position + * @see http://schema.org/numberOfEpisodes */ - public function position($position) + public function numberOfEpisodes($numberOfEpisodes) { - return $this->setProperty('position', $position); + return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); } /** - * The person or organization who produced the work (e.g. music album, - * movie, tv/radio series etc.). + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + + /** + * The TV series to which this episode or season belongs. + * + * @param TVSeries|TVSeries[] $partOfTVSeries + * + * @return static + * + * @see http://schema.org/partOfTVSeries + */ + public function partOfTVSeries($partOfTVSeries) + { + return $this->setProperty('partOfTVSeries', $partOfTVSeries); + } + + /** + * The position of an item in a series or sequence of items. + * + * @param int|int[]|string|string[] $position + * + * @return static + * + * @see http://schema.org/position + */ + public function position($position) + { + return $this->setProperty('position', $position); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * The person or organization who produced the work (e.g. music album, + * movie, tv/radio series etc.). * * @param Organization|Organization[]|Person|Person[] $producer * @@ -991,6 +1236,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1117,6 +1377,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1134,6 +1410,20 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * Position of the season within an ordered group of seasons. + * + * @param int|int[]|string|string[] $seasonNumber + * + * @return static + * + * @see http://schema.org/seasonNumber + */ + public function seasonNumber($seasonNumber) + { + return $this->setProperty('seasonNumber', $seasonNumber); + } + /** * The Organization on whose behalf the creator was working. * @@ -1199,6 +1489,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * + * @return static + * + * @see http://schema.org/startDate + */ + public function startDate($startDate) + { + return $this->setProperty('startDate', $startDate); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1290,6 +1609,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1320,6 +1653,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1363,351 +1710,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * An episode of a tv, radio or game media within a series or season. - * - * @param Episode|Episode[] $episode - * - * @return static - * - * @see http://schema.org/episode - */ - public function episode($episode) - { - return $this->setProperty('episode', $episode); - } - - /** - * An episode of a TV/radio series or season. - * - * @param Episode|Episode[] $episodes - * - * @return static - * - * @see http://schema.org/episodes - */ - public function episodes($episodes) - { - return $this->setProperty('episodes', $episodes); - } - - /** - * The number of episodes in this season or series. - * - * @param int|int[] $numberOfEpisodes - * - * @return static - * - * @see http://schema.org/numberOfEpisodes - */ - public function numberOfEpisodes($numberOfEpisodes) - { - return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * Position of the season within an ordered group of seasons. - * - * @param int|int[]|string|string[] $seasonNumber - * - * @return static - * - * @see http://schema.org/seasonNumber - */ - public function seasonNumber($seasonNumber) - { - return $this->setProperty('seasonNumber', $seasonNumber); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - - /** - * The trailer of a movie or tv/radio series, season, episode, etc. - * - * @param VideoObject|VideoObject[] $trailer - * - * @return static - * - * @see http://schema.org/trailer - */ - public function trailer($trailer) - { - return $this->setProperty('trailer', $trailer); - } - } diff --git a/src/TVSeries.php b/src/TVSeries.php index efc5da4cc..7faf2a9ed 100644 --- a/src/TVSeries.php +++ b/src/TVSeries.php @@ -18,477 +18,323 @@ class TVSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { /** - * 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. + * The subject matter of the content. * - * @param Person|Person[] $actor + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/actor + * @see http://schema.org/about */ - public function actor($actor) + public function about($about) { - return $this->setProperty('actor', $actor); + return $this->setProperty('about', $about); } /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. * - * @param Person|Person[] $actors + * @param string|string[] $accessMode * * @return static * - * @see http://schema.org/actors + * @see http://schema.org/accessMode */ - public function actors($actors) + public function accessMode($accessMode) { - return $this->setProperty('actors', $actors); + return $this->setProperty('accessMode', $accessMode); } /** - * A season that is part of the media series. + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. * - * @param CreativeWorkSeason|CreativeWorkSeason[] $containsSeason + * @param ItemList|ItemList[] $accessModeSufficient * * @return static * - * @see http://schema.org/containsSeason + * @see http://schema.org/accessModeSufficient */ - public function containsSeason($containsSeason) + public function accessModeSufficient($accessModeSufficient) { - return $this->setProperty('containsSeason', $containsSeason); + return $this->setProperty('accessModeSufficient', $accessModeSufficient); } /** - * The country of the principal offices of the production company or - * individual responsible for the movie or program. + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Country|Country[] $countryOfOrigin + * @param string|string[] $accessibilityAPI * * @return static * - * @see http://schema.org/countryOfOrigin + * @see http://schema.org/accessibilityAPI */ - public function countryOfOrigin($countryOfOrigin) + public function accessibilityAPI($accessibilityAPI) { - return $this->setProperty('countryOfOrigin', $countryOfOrigin); + return $this->setProperty('accessibilityAPI', $accessibilityAPI); } /** - * 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. + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Person|Person[] $director + * @param string|string[] $accessibilityControl * * @return static * - * @see http://schema.org/director + * @see http://schema.org/accessibilityControl */ - public function director($director) + public function accessibilityControl($accessibilityControl) { - return $this->setProperty('director', $director); + return $this->setProperty('accessibilityControl', $accessibilityControl); } /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Person|Person[] $directors + * @param string|string[] $accessibilityFeature * * @return static * - * @see http://schema.org/directors + * @see http://schema.org/accessibilityFeature */ - public function directors($directors) + public function accessibilityFeature($accessibilityFeature) { - return $this->setProperty('directors', $directors); + return $this->setProperty('accessibilityFeature', $accessibilityFeature); } /** - * An episode of a tv, radio or game media within a series or season. + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Episode|Episode[] $episode + * @param string|string[] $accessibilityHazard * * @return static * - * @see http://schema.org/episode + * @see http://schema.org/accessibilityHazard */ - public function episode($episode) + public function accessibilityHazard($accessibilityHazard) { - return $this->setProperty('episode', $episode); + return $this->setProperty('accessibilityHazard', $accessibilityHazard); } /** - * An episode of a TV/radio series or season. + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." * - * @param Episode|Episode[] $episodes + * @param string|string[] $accessibilitySummary * * @return static * - * @see http://schema.org/episodes + * @see http://schema.org/accessibilitySummary */ - public function episodes($episodes) + public function accessibilitySummary($accessibilitySummary) { - return $this->setProperty('episodes', $episodes); + return $this->setProperty('accessibilitySummary', $accessibilitySummary); } /** - * The composer of the soundtrack. + * Specifies the Person that is legally accountable for the CreativeWork. * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * @param Person|Person[] $accountablePerson * * @return static * - * @see http://schema.org/musicBy + * @see http://schema.org/accountablePerson */ - public function musicBy($musicBy) + public function accountablePerson($accountablePerson) { - return $this->setProperty('musicBy', $musicBy); + return $this->setProperty('accountablePerson', $accountablePerson); } /** - * The number of episodes in this season or series. + * 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. * - * @param int|int[] $numberOfEpisodes + * @param Person|Person[] $actor * * @return static * - * @see http://schema.org/numberOfEpisodes + * @see http://schema.org/actor */ - public function numberOfEpisodes($numberOfEpisodes) + public function actor($actor) { - return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + return $this->setProperty('actor', $actor); } /** - * The number of seasons in this series. + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. * - * @param int|int[] $numberOfSeasons + * @param Person|Person[] $actors * * @return static * - * @see http://schema.org/numberOfSeasons + * @see http://schema.org/actors */ - public function numberOfSeasons($numberOfSeasons) + public function actors($actors) { - return $this->setProperty('numberOfSeasons', $numberOfSeasons); + return $this->setProperty('actors', $actors); } /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[] $productionCompany + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/productionCompany + * @see http://schema.org/additionalType */ - public function productionCompany($productionCompany) + public function additionalType($additionalType) { - return $this->setProperty('productionCompany', $productionCompany); + return $this->setProperty('additionalType', $additionalType); } /** - * A season in a media series. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param CreativeWorkSeason|CreativeWorkSeason[] $season + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/season + * @see http://schema.org/aggregateRating */ - public function season($season) + public function aggregateRating($aggregateRating) { - return $this->setProperty('season', $season); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * A season in a media series. + * An alias for the item. * - * @param CreativeWorkSeason|CreativeWorkSeason[] $seasons + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/seasons + * @see http://schema.org/alternateName */ - public function seasons($seasons) + public function alternateName($alternateName) { - return $this->setProperty('seasons', $seasons); + return $this->setProperty('alternateName', $alternateName); } /** - * The trailer of a movie or tv/radio series, season, episode, etc. + * A secondary title of the CreativeWork. * - * @param VideoObject|VideoObject[] $trailer + * @param string|string[] $alternativeHeadline * * @return static * - * @see http://schema.org/trailer + * @see http://schema.org/alternativeHeadline */ - public function trailer($trailer) + public function alternativeHeadline($alternativeHeadline) { - return $this->setProperty('trailer', $trailer); + return $this->setProperty('alternativeHeadline', $alternativeHeadline); } /** - * The subject matter of the content. + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. * - * @param Thing|Thing[] $about + * @param MediaObject|MediaObject[] $associatedMedia * * @return static * - * @see http://schema.org/about + * @see http://schema.org/associatedMedia */ - public function about($about) + public function associatedMedia($associatedMedia) { - return $this->setProperty('about', $about); + return $this->setProperty('associatedMedia', $associatedMedia); } /** - * The human sensory perceptual system or cognitive faculty through which a - * person may process or perceive information. Expected values include: - * auditory, tactile, textual, visual, colorDependent, chartOnVisual, - * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * An intended audience, i.e. a group for whom something was created. * - * @param string|string[] $accessMode + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/accessMode + * @see http://schema.org/audience */ - public function accessMode($accessMode) + public function audience($audience) { - return $this->setProperty('accessMode', $accessMode); + return $this->setProperty('audience', $audience); } /** - * A list of single or combined accessModes that are sufficient to - * understand all the intellectual content of a resource. Expected values - * include: auditory, tactile, textual, visual. + * An embedded audio object. * - * @param ItemList|ItemList[] $accessModeSufficient + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio * * @return static * - * @see http://schema.org/accessModeSufficient + * @see http://schema.org/audio */ - public function accessModeSufficient($accessModeSufficient) + public function audio($audio) { - return $this->setProperty('accessModeSufficient', $accessModeSufficient); + return $this->setProperty('audio', $audio); } /** - * Indicates that the resource is compatible with the referenced - * accessibility API ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. * - * @param string|string[] $accessibilityAPI + * @param Organization|Organization[]|Person|Person[] $author * * @return static * - * @see http://schema.org/accessibilityAPI + * @see http://schema.org/author */ - public function accessibilityAPI($accessibilityAPI) + public function author($author) { - return $this->setProperty('accessibilityAPI', $accessibilityAPI); + return $this->setProperty('author', $author); } /** - * Identifies input methods that are sufficient to fully control the - * described resource ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * An award won by or for this item. * - * @param string|string[] $accessibilityControl + * @param string|string[] $award * * @return static * - * @see http://schema.org/accessibilityControl + * @see http://schema.org/award */ - public function accessibilityControl($accessibilityControl) + public function award($award) { - return $this->setProperty('accessibilityControl', $accessibilityControl); + return $this->setProperty('award', $award); } /** - * Content features of the resource, such as accessible media, alternatives - * and supported enhancements for accessibility ([WebSchemas wiki lists - * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * Awards won by or for this item. * - * @param string|string[] $accessibilityFeature + * @param string|string[] $awards * * @return static * - * @see http://schema.org/accessibilityFeature - */ - public function accessibilityFeature($accessibilityFeature) - { - return $this->setProperty('accessibilityFeature', $accessibilityFeature); - } - - /** - * A characteristic of the described resource that is physiologically - * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas - * wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). - * - * @param string|string[] $accessibilityHazard - * - * @return static - * - * @see http://schema.org/accessibilityHazard - */ - public function accessibilityHazard($accessibilityHazard) - { - return $this->setProperty('accessibilityHazard', $accessibilityHazard); - } - - /** - * A human-readable summary of specific accessibility features or - * deficiencies, consistent with the other accessibility metadata but - * expressing subtleties such as "short descriptions are present but long - * descriptions will be needed for non-visual users" or "short descriptions - * are present and no long descriptions are needed." - * - * @param string|string[] $accessibilitySummary - * - * @return static - * - * @see http://schema.org/accessibilitySummary - */ - public function accessibilitySummary($accessibilitySummary) - { - return $this->setProperty('accessibilitySummary', $accessibilitySummary); - } - - /** - * Specifies the Person that is legally accountable for the CreativeWork. - * - * @param Person|Person[] $accountablePerson - * - * @return static - * - * @see http://schema.org/accountablePerson - */ - public function accountablePerson($accountablePerson) - { - return $this->setProperty('accountablePerson', $accountablePerson); - } - - /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. - * - * @param AggregateRating|AggregateRating[] $aggregateRating - * - * @return static - * - * @see http://schema.org/aggregateRating - */ - public function aggregateRating($aggregateRating) - { - return $this->setProperty('aggregateRating', $aggregateRating); - } - - /** - * A secondary title of the CreativeWork. - * - * @param string|string[] $alternativeHeadline - * - * @return static - * - * @see http://schema.org/alternativeHeadline - */ - public function alternativeHeadline($alternativeHeadline) - { - return $this->setProperty('alternativeHeadline', $alternativeHeadline); - } - - /** - * A media object that encodes this CreativeWork. This property is a synonym - * for encoding. - * - * @param MediaObject|MediaObject[] $associatedMedia - * - * @return static - * - * @see http://schema.org/associatedMedia - */ - public function associatedMedia($associatedMedia) - { - return $this->setProperty('associatedMedia', $associatedMedia); - } - - /** - * An intended audience, i.e. a group for whom something was created. - * - * @param Audience|Audience[] $audience - * - * @return static - * - * @see http://schema.org/audience - */ - public function audience($audience) - { - return $this->setProperty('audience', $audience); - } - - /** - * An embedded audio object. - * - * @param AudioObject|AudioObject[]|Clip|Clip[] $audio - * - * @return static - * - * @see http://schema.org/audio - */ - public function audio($audio) - { - return $this->setProperty('audio', $audio); - } - - /** - * The author of this content or rating. Please note that author is special - * in that HTML 5 provides a special mechanism for indicating authorship via - * the rel tag. That is equivalent to this and may be used interchangeably. - * - * @param Organization|Organization[]|Person|Person[] $author - * - * @return static - * - * @see http://schema.org/author - */ - public function author($author) - { - return $this->setProperty('author', $author); - } - - /** - * An award won by or for this item. - * - * @param string|string[] $award - * - * @return static - * - * @see http://schema.org/award - */ - public function award($award) - { - return $this->setProperty('award', $award); - } - - /** - * Awards won by or for this item. - * - * @param string|string[] $awards - * - * @return static - * - * @see http://schema.org/awards + * @see http://schema.org/awards */ public function awards($awards) { @@ -554,6 +400,20 @@ public function commentCount($commentCount) return $this->setProperty('commentCount', $commentCount); } + /** + * A season that is part of the media series. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $containsSeason + * + * @return static + * + * @see http://schema.org/containsSeason + */ + public function containsSeason($containsSeason) + { + return $this->setProperty('containsSeason', $containsSeason); + } + /** * The location depicted or described in the content. For example, the * location in a photograph or painting. @@ -626,6 +486,21 @@ public function copyrightYear($copyrightYear) return $this->setProperty('copyrightYear', $copyrightYear); } + /** + * The country of the principal offices of the production company or + * individual responsible for the movie or program. + * + * @param Country|Country[] $countryOfOrigin + * + * @return static + * + * @see http://schema.org/countryOfOrigin + */ + public function countryOfOrigin($countryOfOrigin) + { + return $this->setProperty('countryOfOrigin', $countryOfOrigin); + } + /** * The creator/author of this CreativeWork. This is the same as the Author * property for CreativeWork. @@ -685,6 +560,68 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -799,7 +736,50 @@ public function encodings($encodings) } /** - * A creative work that this work is an + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An episode of a tv, radio or game media within a series or season. + * + * @param Episode|Episode[] $episode + * + * @return static + * + * @see http://schema.org/episode + */ + public function episode($episode) + { + return $this->setProperty('episode', $episode); + } + + /** + * An episode of a TV/radio series or season. + * + * @param Episode|Episode[] $episodes + * + * @return static + * + * @see http://schema.org/episodes + */ + public function episodes($episodes) + { + return $this->setProperty('episodes', $episodes); + } + + /** + * A creative work that this work is an * example/instance/realization/derivation of. * * @param CreativeWork|CreativeWork[] $exampleOfWork @@ -910,6 +890,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1032,6 +1045,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1107,6 +1136,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1137,6 +1182,62 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of episodes in this season or series. + * + * @param int|int[] $numberOfEpisodes + * + * @return static + * + * @see http://schema.org/numberOfEpisodes + */ + public function numberOfEpisodes($numberOfEpisodes) + { + return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + } + + /** + * The number of seasons in this series. + * + * @param int|int[] $numberOfSeasons + * + * @return static + * + * @see http://schema.org/numberOfSeasons + */ + public function numberOfSeasons($numberOfSeasons) + { + return $this->setProperty('numberOfSeasons', $numberOfSeasons); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1167,6 +1268,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1182,6 +1298,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1308,6 +1439,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1325,6 +1472,34 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A season in a media series. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $season + * + * @return static + * + * @see http://schema.org/season + */ + public function season($season) + { + return $this->setProperty('season', $season); + } + + /** + * A season in a media series. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $seasons + * + * @return static + * + * @see http://schema.org/seasons + */ + public function seasons($seasons) + { + return $this->setProperty('seasons', $seasons); + } + /** * The Organization on whose behalf the creator was working. * @@ -1391,26 +1566,55 @@ public function sponsor($sponsor) } /** - * The "temporal" property can be used in cases where more specific - * properties - * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], - * [[datePublished]]) are not known to be appropriate. + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). * - * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * @param \DateTimeInterface|\DateTimeInterface[] $startDate * * @return static * - * @see http://schema.org/temporal + * @see http://schema.org/startDate */ - public function temporal($temporal) + public function startDate($startDate) { - return $this->setProperty('temporal', $temporal); + return $this->setProperty('startDate', $startDate); } /** - * The temporalCoverage of a CreativeWork indicates the period that the - * content applies to, i.e. that it describes, either as a DateTime or as a - * textual string indicating a time period in [ISO 8601 time interval + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. + * + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * + * @return static + * + * @see http://schema.org/temporal + */ + public function temporal($temporal) + { + return $this->setProperty('temporal', $temporal); + } + + /** + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In * the case of a Dataset it will typically indicate the relevant time * period in a precise notation (e.g. for a 2011 census dataset, the year @@ -1481,6 +1685,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1511,6 +1729,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1554,252 +1786,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate - * - * @return static - * - * @see http://schema.org/endDate - */ - public function endDate($endDate) - { - return $this->setProperty('endDate', $endDate); - } - - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - - /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). - * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate - * - * @return static - * - * @see http://schema.org/startDate - */ - public function startDate($startDate) - { - return $this->setProperty('startDate', $startDate); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - } diff --git a/src/Table.php b/src/Table.php index c98d99654..cc542efd2 100644 --- a/src/Table.php +++ b/src/Table.php @@ -11,6 +11,8 @@ * * @see http://schema.org/Table * + * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] + * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ class Table extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { @@ -158,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -173,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -464,6 +499,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -689,6 +755,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -886,6 +985,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -916,6 +1031,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -946,6 +1075,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1087,6 +1231,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1169,6 +1329,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1290,6 +1464,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1333,190 +1521,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/TakeAction.php b/src/TakeAction.php index ab85efe73..f409e5501 100644 --- a/src/TakeAction.php +++ b/src/TakeAction.php @@ -22,62 +22,96 @@ class TakeAction extends BaseType implements TransferActionContract, ActionContract, ThingContract { /** - * A sub property of location. The original location of the object or the - * agent before the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $fromLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/actionStatus */ - public function fromLocation($fromLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $toLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/additionalType */ - public function toLocation($toLocation) + public function additionalType($additionalType) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -118,288 +152,254 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Thing|Thing[] $object + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/object + * @see http://schema.org/fromLocation */ - public function object($object) + public function fromLocation($fromLocation) { - return $this->setProperty('object', $object); + return $this->setProperty('fromLocation', $fromLocation); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/TattooParlor.php b/src/TattooParlor.php index 7d8a558ef..709523b3e 100644 --- a/src/TattooParlor.php +++ b/src/TattooParlor.php @@ -17,126 +17,104 @@ class TattooParlor extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Taxi.php b/src/Taxi.php index a46e47846..4f26bb203 100644 --- a/src/Taxi.php +++ b/src/Taxi.php @@ -14,6 +14,25 @@ */ class Taxi extends BaseType implements ServiceContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -29,6 +48,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -133,6 +166,37 @@ public function category($category) return $this->setProperty('category', $category); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -162,6 +226,39 @@ public function hoursAvailable($hoursAvailable) return $this->setProperty('hoursAvailable', $hoursAvailable); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another, somehow related product (or multiple products). * @@ -205,6 +302,36 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -221,6 +348,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The tangible thing generated by the service, e.g. a passport, permit, * etc. @@ -280,6 +422,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The geographic area where the service is provided. * @@ -352,164 +510,6 @@ public function slogan($slogan) return $this->setProperty('slogan', $slogan); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - /** * A CreativeWork or Event about this Thing. * diff --git a/src/TaxiReservation.php b/src/TaxiReservation.php index 7e79324b8..c1ce58a7f 100644 --- a/src/TaxiReservation.php +++ b/src/TaxiReservation.php @@ -19,45 +19,36 @@ class TaxiReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { /** - * Number of people the reservation should accommodate. - * - * @param QuantitativeValue|QuantitativeValue[]|int|int[] $partySize - * - * @return static - * - * @see http://schema.org/partySize - */ - public function partySize($partySize) - { - return $this->setProperty('partySize', $partySize); - } - - /** - * Where a taxi will pick up a passenger or a rental car can be picked up. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $pickupLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/pickupLocation + * @see http://schema.org/additionalType */ - public function pickupLocation($pickupLocation) + public function additionalType($additionalType) { - return $this->setProperty('pickupLocation', $pickupLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * When a taxi will pickup a passenger or a rental car can be picked up. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $pickupTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/pickupTime + * @see http://schema.org/alternateName */ - public function pickupTime($pickupTime) + public function alternateName($alternateName) { - return $this->setProperty('pickupTime', $pickupTime); + return $this->setProperty('alternateName', $alternateName); } /** @@ -107,305 +98,278 @@ public function broker($broker) } /** - * The date and time the reservation was modified. - * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime - * - * @return static - * - * @see http://schema.org/modifiedTime - */ - public function modifiedTime($modifiedTime) - { - return $this->setProperty('modifiedTime', $modifiedTime); - } - - /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * A description of the item. * - * @param string|string[] $priceCurrency + * @param string|string[] $description * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/description */ - public function priceCurrency($priceCurrency) + public function description($description) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('description', $description); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * 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. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/disambiguatingDescription */ - public function programMembershipUsed($programMembershipUsed) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/identifier */ - public function provider($provider) + public function identifier($identifier) { - return $this->setProperty('provider', $provider); + return $this->setProperty('identifier', $identifier); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $reservationFor + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/image */ - public function reservationFor($reservationFor) + public function image($image) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('image', $image); } /** - * A unique identifier for the reservation. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $reservationId + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/mainEntityOfPage */ - public function reservationId($reservationId) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The current status of the reservation. + * The date and time the reservation was modified. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/modifiedTime */ - public function reservationStatus($reservationStatus) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * A ticket associated with the reservation. + * The name of the item. * - * @param Ticket|Ticket[] $reservedTicket + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/name */ - public function reservedTicket($reservedTicket) + public function name($name) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('name', $name); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. + * Number of people the reservation should accommodate. * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * @param QuantitativeValue|QuantitativeValue[]|int|int[] $partySize * * @return static * - * @see http://schema.org/totalPrice + * @see http://schema.org/partySize */ - public function totalPrice($totalPrice) + public function partySize($partySize) { - return $this->setProperty('totalPrice', $totalPrice); + return $this->setProperty('partySize', $partySize); } /** - * The person or organization the reservation or ticket is for. + * Where a taxi will pick up a passenger or a rental car can be picked up. * - * @param Organization|Organization[]|Person|Person[] $underName + * @param Place|Place[] $pickupLocation * * @return static * - * @see http://schema.org/underName + * @see http://schema.org/pickupLocation */ - public function underName($underName) + public function pickupLocation($pickupLocation) { - return $this->setProperty('underName', $underName); + return $this->setProperty('pickupLocation', $pickupLocation); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * When a taxi will pickup a passenger or a rental car can be picked up. * - * @param string|string[] $additionalType + * @param \DateTimeInterface|\DateTimeInterface[] $pickupTime * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/pickupTime */ - public function additionalType($additionalType) + public function pickupTime($pickupTime) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('pickupTime', $pickupTime); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $description + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/description + * @see http://schema.org/priceCurrency */ - public function description($description) + public function priceCurrency($priceCurrency) { - return $this->setProperty('description', $description); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * 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. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $disambiguatingDescription + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/programMembershipUsed */ - public function disambiguatingDescription($disambiguatingDescription) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/provider */ - public function identifier($identifier) + public function provider($provider) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('provider', $provider); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservationFor */ - public function image($image) + public function reservationFor($reservationFor) { - return $this->setProperty('image', $image); + return $this->setProperty('reservationFor', $reservationFor); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A unique identifier for the reservation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/reservationId */ - public function mainEntityOfPage($mainEntityOfPage) + public function reservationId($reservationId) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('reservationId', $reservationId); } /** - * The name of the item. + * The current status of the reservation. * - * @param string|string[] $name + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/name + * @see http://schema.org/reservationStatus */ - public function name($name) + public function reservationStatus($reservationStatus) { - return $this->setProperty('name', $name); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A ticket associated with the reservation. * - * @param Action|Action[] $potentialAction + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/reservedTicket */ - public function potentialAction($potentialAction) + public function reservedTicket($reservedTicket) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('reservedTicket', $reservedTicket); } /** @@ -438,6 +402,42 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + /** * URL of the item. * diff --git a/src/TaxiService.php b/src/TaxiService.php index 70ea6e7bd..13e3afbe1 100644 --- a/src/TaxiService.php +++ b/src/TaxiService.php @@ -15,6 +15,25 @@ */ class TaxiService extends BaseType implements ServiceContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -30,6 +49,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -134,6 +167,37 @@ public function category($category) return $this->setProperty('category', $category); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -163,6 +227,39 @@ public function hoursAvailable($hoursAvailable) return $this->setProperty('hoursAvailable', $hoursAvailable); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another, somehow related product (or multiple products). * @@ -206,6 +303,36 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -222,6 +349,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The tangible thing generated by the service, e.g. a passport, permit, * etc. @@ -281,6 +423,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The geographic area where the service is provided. * @@ -353,164 +511,6 @@ public function slogan($slogan) return $this->setProperty('slogan', $slogan); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - /** * A CreativeWork or Event about this Thing. * diff --git a/src/TaxiStand.php b/src/TaxiStand.php index f1a2f822c..c4ce5db70 100644 --- a/src/TaxiStand.php +++ b/src/TaxiStand.php @@ -14,35 +14,6 @@ */ class TaxiStand extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/TechArticle.php b/src/TechArticle.php index e29dace50..8feadb668 100644 --- a/src/TechArticle.php +++ b/src/TechArticle.php @@ -15,160 +15,6 @@ */ class TechArticle extends BaseType implements ArticleContract, CreativeWorkContract, ThingContract { - /** - * Prerequisites needed to fulfill steps in article. - * - * @param string|string[] $dependencies - * - * @return static - * - * @see http://schema.org/dependencies - */ - public function dependencies($dependencies) - { - return $this->setProperty('dependencies', $dependencies); - } - - /** - * Proficiency needed for this content; expected values: 'Beginner', - * 'Expert'. - * - * @param string|string[] $proficiencyLevel - * - * @return static - * - * @see http://schema.org/proficiencyLevel - */ - public function proficiencyLevel($proficiencyLevel) - { - return $this->setProperty('proficiencyLevel', $proficiencyLevel); - } - - /** - * The actual body of the article. - * - * @param string|string[] $articleBody - * - * @return static - * - * @see http://schema.org/articleBody - */ - public function articleBody($articleBody) - { - return $this->setProperty('articleBody', $articleBody); - } - - /** - * Articles may belong to one or more 'sections' in a magazine or newspaper, - * such as Sports, Lifestyle, etc. - * - * @param string|string[] $articleSection - * - * @return static - * - * @see http://schema.org/articleSection - */ - public function articleSection($articleSection) - { - return $this->setProperty('articleSection', $articleSection); - } - - /** - * The page on which the work ends; for example "138" or "xvi". - * - * @param int|int[]|string|string[] $pageEnd - * - * @return static - * - * @see http://schema.org/pageEnd - */ - public function pageEnd($pageEnd) - { - return $this->setProperty('pageEnd', $pageEnd); - } - - /** - * The page on which the work starts; for example "135" or "xiii". - * - * @param int|int[]|string|string[] $pageStart - * - * @return static - * - * @see http://schema.org/pageStart - */ - public function pageStart($pageStart) - { - return $this->setProperty('pageStart', $pageStart); - } - - /** - * Any description of pages that is not separated into pageStart and - * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". - * - * @param string|string[] $pagination - * - * @return static - * - * @see http://schema.org/pagination - */ - public function pagination($pagination) - { - return $this->setProperty('pagination', $pagination); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * The number of words in the text of the Article. - * - * @param int|int[] $wordCount - * - * @return static - * - * @see http://schema.org/wordCount - */ - public function wordCount($wordCount) - { - return $this->setProperty('wordCount', $wordCount); - } - /** * The subject matter of the content. * @@ -313,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -328,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -342,6 +221,35 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The actual body of the article. + * + * @param string|string[] $articleBody + * + * @return static + * + * @see http://schema.org/articleBody + */ + public function articleBody($articleBody) + { + return $this->setProperty('articleBody', $articleBody); + } + + /** + * Articles may belong to one or more 'sections' in a magazine or newspaper, + * such as Sports, Lifestyle, etc. + * + * @param string|string[] $articleSection + * + * @return static + * + * @see http://schema.org/articleSection + */ + public function articleSection($articleSection) + { + return $this->setProperty('articleSection', $articleSection); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -620,56 +528,101 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * Prerequisites needed to fulfill steps in article. * - * @param string|string[] $discussionUrl + * @param string|string[] $dependencies * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/dependencies */ - public function discussionUrl($discussionUrl) + public function dependencies($dependencies) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('dependencies', $dependencies); } /** - * Specifies the Person who edited the CreativeWork. + * A description of the item. * - * @param Person|Person[] $editor + * @param string|string[] $description * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/description */ - public function editor($editor) + public function description($description) { - return $this->setProperty('editor', $editor); + return $this->setProperty('description', $description); } /** - * An alignment to an established educational framework. + * 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. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/disambiguatingDescription */ - public function educationalAlignment($educationalAlignment) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * A link to the page containing the comments of the CreativeWork. * - * @param string|string[] $educationalUse + * @param string|string[] $discussionUrl * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse */ public function educationalUse($educationalUse) { @@ -844,6 +797,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1041,6 +1027,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1071,6 +1073,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1087,6 +1103,49 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The page on which the work ends; for example "138" or "xvi". + * + * @param int|int[]|string|string[] $pageEnd + * + * @return static + * + * @see http://schema.org/pageEnd + */ + public function pageEnd($pageEnd) + { + return $this->setProperty('pageEnd', $pageEnd); + } + + /** + * The page on which the work starts; for example "135" or "xiii". + * + * @param int|int[]|string|string[] $pageStart + * + * @return static + * + * @see http://schema.org/pageStart + */ + public function pageStart($pageStart) + { + return $this->setProperty('pageStart', $pageStart); + } + + /** + * Any description of pages that is not separated into pageStart and + * pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". + * + * @param string|string[] $pagination + * + * @return static + * + * @see http://schema.org/pagination + */ + public function pagination($pagination) + { + return $this->setProperty('pagination', $pagination); + } + /** * The position of an item in a series or sequence of items. * @@ -1101,6 +1160,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1116,6 +1190,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * Proficiency needed for this content; expected values: 'Beginner', + * 'Expert'. + * + * @param string|string[] $proficiencyLevel + * + * @return static + * + * @see http://schema.org/proficiencyLevel + */ + public function proficiencyLevel($proficiencyLevel) + { + return $this->setProperty('proficiencyLevel', $proficiencyLevel); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1242,6 +1331,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1308,6 +1413,45 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + /** * 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 @@ -1324,6 +1468,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1445,6 +1603,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1474,204 +1646,32 @@ public function video($video) } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * The number of words in the text of the Article. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param int|int[] $wordCount * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/wordCount */ - public function subjectOf($subjectOf) + public function wordCount($wordCount) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('wordCount', $wordCount); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/TelevisionChannel.php b/src/TelevisionChannel.php index 6abb0c1df..dfa4f5fb3 100644 --- a/src/TelevisionChannel.php +++ b/src/TelevisionChannel.php @@ -15,6 +15,39 @@ */ class TelevisionChannel extends BaseType implements BroadcastChannelContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The unique address by which the BroadcastService can be identified in a * provider lineup. In US, this is typically a number. @@ -61,81 +94,6 @@ public function broadcastServiceTier($broadcastServiceTier) return $this->setProperty('broadcastServiceTier', $broadcastServiceTier); } - /** - * Genre of the creative work, broadcast channel or group. - * - * @param string|string[] $genre - * - * @return static - * - * @see http://schema.org/genre - */ - public function genre($genre) - { - return $this->setProperty('genre', $genre); - } - - /** - * The CableOrSatelliteService offering the channel. - * - * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup - * - * @return static - * - * @see http://schema.org/inBroadcastLineup - */ - public function inBroadcastLineup($inBroadcastLineup) - { - return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); - } - - /** - * The BroadcastService offered on this channel. - * - * @param BroadcastService|BroadcastService[] $providesBroadcastService - * - * @return static - * - * @see http://schema.org/providesBroadcastService - */ - public function providesBroadcastService($providesBroadcastService) - { - return $this->setProperty('providesBroadcastService', $providesBroadcastService); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - /** * A description of the item. * @@ -167,6 +125,20 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * Genre of the creative work, broadcast channel or group. + * + * @param string|string[] $genre + * + * @return static + * + * @see http://schema.org/genre + */ + public function genre($genre) + { + return $this->setProperty('genre', $genre); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -200,6 +172,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The CableOrSatelliteService offering the channel. + * + * @param CableOrSatelliteService|CableOrSatelliteService[] $inBroadcastLineup + * + * @return static + * + * @see http://schema.org/inBroadcastLineup + */ + public function inBroadcastLineup($inBroadcastLineup) + { + return $this->setProperty('inBroadcastLineup', $inBroadcastLineup); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -245,6 +231,20 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The BroadcastService offered on this channel. + * + * @param BroadcastService|BroadcastService[] $providesBroadcastService + * + * @return static + * + * @see http://schema.org/providesBroadcastService + */ + public function providesBroadcastService($providesBroadcastService) + { + return $this->setProperty('providesBroadcastService', $providesBroadcastService); + } + /** * 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 diff --git a/src/TelevisionStation.php b/src/TelevisionStation.php index c4fb1206a..77df620b6 100644 --- a/src/TelevisionStation.php +++ b/src/TelevisionStation.php @@ -16,126 +16,104 @@ class TelevisionStation extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/TennisComplex.php b/src/TennisComplex.php index 64996943e..0e016c093 100644 --- a/src/TennisComplex.php +++ b/src/TennisComplex.php @@ -17,126 +17,104 @@ class TennisComplex extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/TextDigitalDocument.php b/src/TextDigitalDocument.php index bd4371bc9..2d63804c2 100644 --- a/src/TextDigitalDocument.php +++ b/src/TextDigitalDocument.php @@ -14,22 +14,6 @@ */ class TextDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract { - /** - * A permission related to the access to this document (e.g. permission to - * read or write an electronic document). For a public document, specify a - * grantee with an Audience with audienceType equal to "public". - * - * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission - * - * @return static - * - * @see http://schema.org/hasDigitalDocumentPermission - */ - public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) - { - return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); - } - /** * The subject matter of the content. * @@ -174,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -189,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -480,6 +497,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -676,6 +724,22 @@ public function genre($genre) return $this->setProperty('genre', $genre); } + /** + * A permission related to the access to this document (e.g. permission to + * read or write an electronic document). For a public document, specify a + * grantee with an Audience with audienceType equal to "public". + * + * @param DigitalDocumentPermission|DigitalDocumentPermission[] $hasDigitalDocumentPermission + * + * @return static + * + * @see http://schema.org/hasDigitalDocumentPermission + */ + public function hasDigitalDocumentPermission($hasDigitalDocumentPermission) + { + return $this->setProperty('hasDigitalDocumentPermission', $hasDigitalDocumentPermission); + } + /** * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). @@ -705,6 +769,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -902,6 +999,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -932,6 +1045,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -962,6 +1089,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1103,6 +1245,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1185,6 +1343,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1306,6 +1478,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1349,190 +1535,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/TheaterEvent.php b/src/TheaterEvent.php index 224fb6929..2cf48f118 100644 --- a/src/TheaterEvent.php +++ b/src/TheaterEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/TheaterGroup.php b/src/TheaterGroup.php index 5b50e5bb9..d83dca87c 100644 --- a/src/TheaterGroup.php +++ b/src/TheaterGroup.php @@ -15,6 +15,25 @@ */ class TheaterGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -44,6 +63,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -146,6 +179,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -377,6 +441,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -451,6 +548,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -524,6 +637,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -581,6 +708,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -633,6 +775,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -708,6 +866,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -738,203 +910,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Ticket.php b/src/Ticket.php index 73cbd9f32..9620707f3 100644 --- a/src/Ticket.php +++ b/src/Ticket.php @@ -13,136 +13,6 @@ */ class Ticket extends BaseType implements IntangibleContract, ThingContract { - /** - * The date the ticket was issued. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateIssued - * - * @return static - * - * @see http://schema.org/dateIssued - */ - public function dateIssued($dateIssued) - { - return $this->setProperty('dateIssued', $dateIssued); - } - - /** - * The organization issuing the ticket or permit. - * - * @param Organization|Organization[] $issuedBy - * - * @return static - * - * @see http://schema.org/issuedBy - */ - public function issuedBy($issuedBy) - { - return $this->setProperty('issuedBy', $issuedBy); - } - - /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". - * - * @param string|string[] $priceCurrency - * - * @return static - * - * @see http://schema.org/priceCurrency - */ - public function priceCurrency($priceCurrency) - { - return $this->setProperty('priceCurrency', $priceCurrency); - } - - /** - * The unique identifier for the ticket. - * - * @param string|string[] $ticketNumber - * - * @return static - * - * @see http://schema.org/ticketNumber - */ - public function ticketNumber($ticketNumber) - { - return $this->setProperty('ticketNumber', $ticketNumber); - } - - /** - * Reference to an asset (e.g., Barcode, QR code image or PDF) usable for - * entrance. - * - * @param string|string[] $ticketToken - * - * @return static - * - * @see http://schema.org/ticketToken - */ - public function ticketToken($ticketToken) - { - return $this->setProperty('ticketToken', $ticketToken); - } - - /** - * The seat associated with the ticket. - * - * @param Seat|Seat[] $ticketedSeat - * - * @return static - * - * @see http://schema.org/ticketedSeat - */ - public function ticketedSeat($ticketedSeat) - { - return $this->setProperty('ticketedSeat', $ticketedSeat); - } - - /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: - * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice - * - * @return static - * - * @see http://schema.org/totalPrice - */ - public function totalPrice($totalPrice) - { - return $this->setProperty('totalPrice', $totalPrice); - } - - /** - * The person or organization the reservation or ticket is for. - * - * @param Organization|Organization[]|Person|Person[] $underName - * - * @return static - * - * @see http://schema.org/underName - */ - public function underName($underName) - { - return $this->setProperty('underName', $underName); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -176,6 +46,20 @@ public function alternateName($alternateName) return $this->setProperty('alternateName', $alternateName); } + /** + * The date the ticket was issued. + * + * @param \DateTimeInterface|\DateTimeInterface[] $dateIssued + * + * @return static + * + * @see http://schema.org/dateIssued + */ + public function dateIssued($dateIssued) + { + return $this->setProperty('dateIssued', $dateIssued); + } + /** * A description of the item. * @@ -240,6 +124,20 @@ public function image($image) return $this->setProperty('image', $image); } + /** + * The organization issuing the ticket or permit. + * + * @param Organization|Organization[] $issuedBy + * + * @return static + * + * @see http://schema.org/issuedBy + */ + public function issuedBy($issuedBy) + { + return $this->setProperty('issuedBy', $issuedBy); + } + /** * Indicates a page (or other CreativeWork) for which this thing is the main * entity being described. See [background @@ -285,6 +183,29 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $priceCurrency + * + * @return static + * + * @see http://schema.org/priceCurrency + */ + public function priceCurrency($priceCurrency) + { + return $this->setProperty('priceCurrency', $priceCurrency); + } + /** * 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 @@ -315,6 +236,85 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The unique identifier for the ticket. + * + * @param string|string[] $ticketNumber + * + * @return static + * + * @see http://schema.org/ticketNumber + */ + public function ticketNumber($ticketNumber) + { + return $this->setProperty('ticketNumber', $ticketNumber); + } + + /** + * Reference to an asset (e.g., Barcode, QR code image or PDF) usable for + * entrance. + * + * @param string|string[] $ticketToken + * + * @return static + * + * @see http://schema.org/ticketToken + */ + public function ticketToken($ticketToken) + { + return $this->setProperty('ticketToken', $ticketToken); + } + + /** + * The seat associated with the ticket. + * + * @param Seat|Seat[] $ticketedSeat + * + * @return static + * + * @see http://schema.org/ticketedSeat + */ + public function ticketedSeat($ticketedSeat) + { + return $this->setProperty('ticketedSeat', $ticketedSeat); + } + + /** + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice + * + * @return static + * + * @see http://schema.org/totalPrice + */ + public function totalPrice($totalPrice) + { + return $this->setProperty('totalPrice', $totalPrice); + } + + /** + * The person or organization the reservation or ticket is for. + * + * @param Organization|Organization[]|Person|Person[] $underName + * + * @return static + * + * @see http://schema.org/underName + */ + public function underName($underName) + { + return $this->setProperty('underName', $underName); + } + /** * URL of the item. * diff --git a/src/TieAction.php b/src/TieAction.php index 1de0a1ff3..76d3fd231 100644 --- a/src/TieAction.php +++ b/src/TieAction.php @@ -29,340 +29,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/TipAction.php b/src/TipAction.php index f1e205f3a..eb1185362 100644 --- a/src/TipAction.php +++ b/src/TipAction.php @@ -16,122 +16,96 @@ class TipAction extends BaseType implements TradeActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The participant who is at the receiving - * end of the action. + * Indicates the current disposition of the Action. * - * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/recipient + * @see http://schema.org/actionStatus */ - public function recipient($recipient) + public function actionStatus($actionStatus) { - return $this->setProperty('recipient', $recipient); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param float|float[]|int|int[]|string|string[] $price + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/price + * @see http://schema.org/additionalType */ - public function price($price) + public function additionalType($additionalType) { - return $this->setProperty('price', $price); + return $this->setProperty('additionalType', $additionalType); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param string|string[] $priceCurrency + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/agent */ - public function priceCurrency($priceCurrency) + public function agent($agent) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('agent', $agent); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * An alias for the item. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/alternateName */ - public function priceSpecification($priceSpecification) + public function alternateName($alternateName) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicates the current disposition of the Action. + * A description of the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $description * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/description */ - public function actionStatus($actionStatus) + public function description($description) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('description', $description); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/disambiguatingDescription */ - public function agent($agent) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('agent', $agent); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -172,288 +146,314 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $instrument + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/identifier */ - public function instrument($instrument) + public function identifier($identifier) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('identifier', $identifier); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/location + * @see http://schema.org/image */ - public function location($location) + public function image($image) { - return $this->setProperty('location', $location); + return $this->setProperty('image', $image); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/object + * @see http://schema.org/instrument */ - public function object($object) + public function instrument($instrument) { - return $this->setProperty('object', $object); + return $this->setProperty('instrument', $instrument); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/location */ - public function participant($participant) + public function location($location) { - return $this->setProperty('participant', $participant); + return $this->setProperty('location', $location); } /** - * The result produced in the action. e.g. John wrote *a book*. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $result + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/result + * @see http://schema.org/mainEntityOfPage */ - public function result($result) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('result', $result); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The name of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param string|string[] $name * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/name */ - public function startTime($startTime) + public function name($name) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('name', $name); } /** - * Indicates a target EntryPoint for an Action. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/target + * @see http://schema.org/object */ - public function target($target) + public function object($object) { - return $this->setProperty('target', $target); + return $this->setProperty('object', $object); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $additionalType + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/participant */ - public function additionalType($additionalType) + public function participant($participant) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('participant', $participant); } /** - * An alias for the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $alternateName + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/potentialAction */ - public function alternateName($alternateName) + public function potentialAction($potentialAction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A description of the item. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $description + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/description + * @see http://schema.org/price */ - public function description($description) + public function price($price) { - return $this->setProperty('description', $description); + return $this->setProperty('price', $price); } /** - * 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. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/priceCurrency */ - public function disambiguatingDescription($disambiguatingDescription) + public function priceCurrency($priceCurrency) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceSpecification */ - public function identifier($identifier) + public function priceSpecification($priceSpecification) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A sub property of participant. The participant who is at the receiving + * end of the action. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Audience|Audience[]|ContactPoint|ContactPoint[]|Organization|Organization[]|Person|Person[] $recipient * * @return static * - * @see http://schema.org/image + * @see http://schema.org/recipient */ - public function image($image) + public function recipient($recipient) { - return $this->setProperty('image', $image); + return $this->setProperty('recipient', $recipient); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/TireShop.php b/src/TireShop.php index fc40cabe2..377315d22 100644 --- a/src/TireShop.php +++ b/src/TireShop.php @@ -17,126 +17,104 @@ class TireShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/TouristAttraction.php b/src/TouristAttraction.php index dc082cffe..ded883675 100644 --- a/src/TouristAttraction.php +++ b/src/TouristAttraction.php @@ -17,37 +17,6 @@ */ class TouristAttraction extends BaseType implements PlaceContract, ThingContract { - /** - * A language someone may use with or at the item, service or place. Please - * use one of the language codes from the [IETF BCP 47 - * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] - * - * @param Language|Language[]|string|string[] $availableLanguage - * - * @return static - * - * @see http://schema.org/availableLanguage - */ - public function availableLanguage($availableLanguage) - { - return $this->setProperty('availableLanguage', $availableLanguage); - } - - /** - * Attraction suitable for type(s) of tourist. eg. Children, visitors from a - * particular country, etc. - * - * @param Audience|Audience[]|string|string[] $touristType - * - * @return static - * - * @see http://schema.org/touristType - */ - public function touristType($touristType) - { - return $this->setProperty('touristType', $touristType); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -70,6 +39,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -99,6 +87,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -116,6 +118,22 @@ public function amenityFeature($amenityFeature) return $this->setProperty('amenityFeature', $amenityFeature); } + /** + * A language someone may use with or at the item, service or place. Please + * use one of the language codes from the [IETF BCP 47 + * standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]] + * + * @param Language|Language[]|string|string[] $availableLanguage + * + * @return static + * + * @see http://schema.org/availableLanguage + */ + public function availableLanguage($availableLanguage) + { + return $this->setProperty('availableLanguage', $availableLanguage); + } + /** * A short textual code (also called "store code") that uniquely identifies * a place of business. The code is typically assigned by the @@ -179,6 +197,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -267,6 +316,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -341,6 +423,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -383,6 +481,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -425,6 +537,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -468,6 +595,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -515,189 +658,46 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The telephone number. * - * @param string|string[] $sameAs + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/telephone */ - public function sameAs($sameAs) + public function telephone($telephone) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('telephone', $telephone); } /** - * A CreativeWork or Event about this Thing. + * Attraction suitable for type(s) of tourist. eg. Children, visitors from a + * particular country, etc. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Audience|Audience[]|string|string[] $touristType * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/touristType */ - public function subjectOf($subjectOf) + public function touristType($touristType) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('touristType', $touristType); } /** diff --git a/src/TouristInformationCenter.php b/src/TouristInformationCenter.php index f6c66e58f..5cf8522c3 100644 --- a/src/TouristInformationCenter.php +++ b/src/TouristInformationCenter.php @@ -16,126 +16,104 @@ class TouristInformationCenter extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/ToyStore.php b/src/ToyStore.php index 79e50ed6c..687512d77 100644 --- a/src/ToyStore.php +++ b/src/ToyStore.php @@ -17,126 +17,104 @@ class ToyStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/TrackAction.php b/src/TrackAction.php index 0787f1900..14407e842 100644 --- a/src/TrackAction.php +++ b/src/TrackAction.php @@ -22,31 +22,36 @@ class TrackAction extends BaseType implements FindActionContract, ActionContract, ThingContract { /** - * A sub property of instrument. The method of delivery. + * Indicates the current disposition of the Action. * - * @param DeliveryMethod|DeliveryMethod[] $deliveryMethod + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/deliveryMethod + * @see http://schema.org/actionStatus */ - public function deliveryMethod($deliveryMethod) + public function actionStatus($actionStatus) { - return $this->setProperty('deliveryMethod', $deliveryMethod); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -65,325 +70,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A sub property of instrument. The method of delivery. * - * @param Thing|Thing[] $error + * @param DeliveryMethod|DeliveryMethod[] $deliveryMethod * * @return static * - * @see http://schema.org/error + * @see http://schema.org/deliveryMethod */ - public function error($error) + public function deliveryMethod($deliveryMethod) { - return $this->setProperty('error', $error); + return $this->setProperty('deliveryMethod', $deliveryMethod); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/TradeAction.php b/src/TradeAction.php index 1b4f119e9..4b5d12393 100644 --- a/src/TradeAction.php +++ b/src/TradeAction.php @@ -16,107 +16,96 @@ class TradeAction extends BaseType implements ActionContract, ThingContract { /** - * The offer price of a product, or of a price component when attached to - * PriceSpecification and its subtypes. - * - * Usage guidelines: - * - * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 - * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; - * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) - * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including - * [ambiguous - * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) - * such as '$' in the value. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * * Note that both - * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) - * and Microdata syntax allow the use of a "content=" attribute for - * publishing simple machine-readable values alongside more human-friendly - * formatting. - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * Indicates the current disposition of the Action. * - * @param float|float[]|int|int[]|string|string[] $price + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/price + * @see http://schema.org/actionStatus */ - public function price($price) + public function actionStatus($actionStatus) { - return $this->setProperty('price', $price); + return $this->setProperty('actionStatus', $actionStatus); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $priceCurrency + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/additionalType */ - public function priceCurrency($priceCurrency) + public function additionalType($additionalType) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('additionalType', $additionalType); } /** - * One or more detailed price specifications, indicating the unit price and - * delivery or payment charges. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param PriceSpecification|PriceSpecification[] $priceSpecification + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/priceSpecification + * @see http://schema.org/agent */ - public function priceSpecification($priceSpecification) + public function agent($agent) { - return $this->setProperty('priceSpecification', $priceSpecification); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -157,288 +146,299 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/location + * @see http://schema.org/identifier */ - public function location($location) + public function identifier($identifier) { - return $this->setProperty('location', $location); + return $this->setProperty('identifier', $identifier); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $object + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/object + * @see http://schema.org/image */ - public function object($object) + public function image($image) { - return $this->setProperty('object', $object); + return $this->setProperty('image', $image); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/instrument */ - public function participant($participant) + public function instrument($instrument) { - return $this->setProperty('participant', $participant); + return $this->setProperty('instrument', $instrument); } /** - * The result produced in the action. e.g. John wrote *a book*. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Thing|Thing[] $result + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/result + * @see http://schema.org/location */ - public function result($result) + public function location($location) { - return $this->setProperty('result', $result); + return $this->setProperty('location', $location); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/mainEntityOfPage */ - public function startTime($startTime) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * Indicates a target EntryPoint for an Action. + * The name of the item. * - * @param EntryPoint|EntryPoint[] $target + * @param string|string[] $name * * @return static * - * @see http://schema.org/target + * @see http://schema.org/name */ - public function target($target) + public function name($name) { - return $this->setProperty('target', $target); + return $this->setProperty('name', $name); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $additionalType + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/object */ - public function additionalType($additionalType) + public function object($object) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('object', $object); } /** - * An alias for the item. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $alternateName + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/participant */ - public function alternateName($alternateName) + public function participant($participant) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('participant', $participant); } /** - * A description of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $description + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/description + * @see http://schema.org/potentialAction */ - public function description($description) + public function potentialAction($potentialAction) { - return $this->setProperty('description', $description); + return $this->setProperty('potentialAction', $potentialAction); } /** - * 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. + * The offer price of a product, or of a price component when attached to + * PriceSpecification and its subtypes. + * + * Usage guidelines: + * + * * Use the [[priceCurrency]] property (with standard formats: [ISO 4217 + * currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; + * [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) + * for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR") instead of including + * [ambiguous + * symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) + * such as '$' in the value. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. + * * Note that both + * [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) + * and Microdata syntax allow the use of a "content=" attribute for + * publishing simple machine-readable values alongside more human-friendly + * formatting. + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. * - * @param string|string[] $disambiguatingDescription + * @param float|float[]|int|int[]|string|string[] $price * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/price */ - public function disambiguatingDescription($disambiguatingDescription) + public function price($price) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('price', $price); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/priceCurrency */ - public function identifier($identifier) + public function priceCurrency($priceCurrency) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * One or more detailed price specifications, indicating the unit price and + * delivery or payment charges. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param PriceSpecification|PriceSpecification[] $priceSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/priceSpecification */ - public function image($image) + public function priceSpecification($priceSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('priceSpecification', $priceSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/TrainReservation.php b/src/TrainReservation.php index 51a42d009..424933ef9 100644 --- a/src/TrainReservation.php +++ b/src/TrainReservation.php @@ -18,6 +18,39 @@ */ class TrainReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * 'bookingAgent' is an out-dated term indicating a 'broker' that serves as * a booking agent. @@ -65,335 +98,302 @@ public function broker($broker) } /** - * The date and time the reservation was modified. + * A description of the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime + * @param string|string[] $description * * @return static * - * @see http://schema.org/modifiedTime + * @see http://schema.org/description */ - public function modifiedTime($modifiedTime) + public function description($description) { - return $this->setProperty('modifiedTime', $modifiedTime); + return $this->setProperty('description', $description); } /** - * The currency of the price, or a price component when attached to - * [[PriceSpecification]] and its subtypes. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * 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. * - * @param string|string[] $priceCurrency + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/priceCurrency + * @see http://schema.org/disambiguatingDescription */ - public function priceCurrency($priceCurrency) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('priceCurrency', $priceCurrency); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Any membership in a frequent flyer, hotel loyalty program, etc. being - * applied to the reservation. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param ProgramMembership|ProgramMembership[] $programMembershipUsed + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/programMembershipUsed + * @see http://schema.org/identifier */ - public function programMembershipUsed($programMembershipUsed) + public function identifier($identifier) { - return $this->setProperty('programMembershipUsed', $programMembershipUsed); + return $this->setProperty('identifier', $identifier); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/image */ - public function provider($provider) + public function image($image) { - return $this->setProperty('provider', $provider); + return $this->setProperty('image', $image); } /** - * The thing -- flight, event, restaurant,etc. being reserved. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Thing|Thing[] $reservationFor + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reservationFor + * @see http://schema.org/mainEntityOfPage */ - public function reservationFor($reservationFor) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reservationFor', $reservationFor); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A unique identifier for the reservation. + * The date and time the reservation was modified. * - * @param string|string[] $reservationId + * @param \DateTimeInterface|\DateTimeInterface[] $modifiedTime * * @return static * - * @see http://schema.org/reservationId + * @see http://schema.org/modifiedTime */ - public function reservationId($reservationId) + public function modifiedTime($modifiedTime) { - return $this->setProperty('reservationId', $reservationId); + return $this->setProperty('modifiedTime', $modifiedTime); } /** - * The current status of the reservation. + * The name of the item. * - * @param ReservationStatusType|ReservationStatusType[] $reservationStatus + * @param string|string[] $name * * @return static * - * @see http://schema.org/reservationStatus + * @see http://schema.org/name */ - public function reservationStatus($reservationStatus) + public function name($name) { - return $this->setProperty('reservationStatus', $reservationStatus); + return $this->setProperty('name', $name); } /** - * A ticket associated with the reservation. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param Ticket|Ticket[] $reservedTicket + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/reservedTicket + * @see http://schema.org/potentialAction */ - public function reservedTicket($reservedTicket) + public function potentialAction($potentialAction) { - return $this->setProperty('reservedTicket', $reservedTicket); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The total price for the reservation or ticket, including applicable - * taxes, shipping, etc. - * - * Usage guidelines: + * The currency of the price, or a price component when attached to + * [[PriceSpecification]] and its subtypes. * - * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT - * NINE' (U+0039)) rather than superficially similiar Unicode symbols. - * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a - * decimal point. Avoid using these symbols as a readability separator. - * - * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice - * - * @return static - * - * @see http://schema.org/totalPrice - */ - public function totalPrice($totalPrice) - { - return $this->setProperty('totalPrice', $totalPrice); - } - - /** - * The person or organization the reservation or ticket is for. - * - * @param Organization|Organization[]|Person|Person[] $underName - * - * @return static - * - * @see http://schema.org/underName - */ - public function underName($underName) - { - return $this->setProperty('underName', $underName); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param string|string[] $additionalType + * @param string|string[] $priceCurrency * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/priceCurrency */ - public function additionalType($additionalType) + public function priceCurrency($priceCurrency) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('priceCurrency', $priceCurrency); } /** - * An alias for the item. + * Any membership in a frequent flyer, hotel loyalty program, etc. being + * applied to the reservation. * - * @param string|string[] $alternateName + * @param ProgramMembership|ProgramMembership[] $programMembershipUsed * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/programMembershipUsed */ - public function alternateName($alternateName) + public function programMembershipUsed($programMembershipUsed) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('programMembershipUsed', $programMembershipUsed); } /** - * A description of the item. + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. * - * @param string|string[] $description + * @param Organization|Organization[]|Person|Person[] $provider * * @return static * - * @see http://schema.org/description + * @see http://schema.org/provider */ - public function description($description) + public function provider($provider) { - return $this->setProperty('description', $description); + return $this->setProperty('provider', $provider); } /** - * 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. + * The thing -- flight, event, restaurant,etc. being reserved. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $reservationFor * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/reservationFor */ - public function disambiguatingDescription($disambiguatingDescription) + public function reservationFor($reservationFor) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('reservationFor', $reservationFor); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A unique identifier for the reservation. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $reservationId * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/reservationId */ - public function identifier($identifier) + public function reservationId($reservationId) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('reservationId', $reservationId); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The current status of the reservation. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param ReservationStatusType|ReservationStatusType[] $reservationStatus * * @return static * - * @see http://schema.org/image + * @see http://schema.org/reservationStatus */ - public function image($image) + public function reservationStatus($reservationStatus) { - return $this->setProperty('image', $image); + return $this->setProperty('reservationStatus', $reservationStatus); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A ticket associated with the reservation. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Ticket|Ticket[] $reservedTicket * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/reservedTicket */ - public function mainEntityOfPage($mainEntityOfPage) + public function reservedTicket($reservedTicket) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('reservedTicket', $reservedTicket); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * The total price for the reservation or ticket, including applicable + * taxes, shipping, etc. + * + * Usage guidelines: + * + * * Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT + * NINE' (U+0039)) rather than superficially similiar Unicode symbols. + * * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a + * decimal point. Avoid using these symbols as a readability separator. * - * @param string|string[] $sameAs + * @param PriceSpecification|PriceSpecification[]|float|float[]|int|int[]|string|string[] $totalPrice * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/totalPrice */ - public function sameAs($sameAs) + public function totalPrice($totalPrice) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('totalPrice', $totalPrice); } /** - * A CreativeWork or Event about this Thing. + * The person or organization the reservation or ticket is for. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Organization|Organization[]|Person|Person[] $underName * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/underName */ - public function subjectOf($subjectOf) + public function underName($underName) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('underName', $underName); } /** diff --git a/src/TrainStation.php b/src/TrainStation.php index 5d8041b90..145667486 100644 --- a/src/TrainStation.php +++ b/src/TrainStation.php @@ -14,35 +14,6 @@ */ class TrainStation extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/TrainTrip.php b/src/TrainTrip.php index 83397f9b1..db7bdf8d7 100644 --- a/src/TrainTrip.php +++ b/src/TrainTrip.php @@ -15,87 +15,64 @@ class TrainTrip extends BaseType implements TripContract, IntangibleContract, ThingContract { /** - * The platform where the train arrives. - * - * @param string|string[] $arrivalPlatform - * - * @return static - * - * @see http://schema.org/arrivalPlatform - */ - public function arrivalPlatform($arrivalPlatform) - { - return $this->setProperty('arrivalPlatform', $arrivalPlatform); - } - - /** - * The station where the train trip ends. - * - * @param TrainStation|TrainStation[] $arrivalStation - * - * @return static - * - * @see http://schema.org/arrivalStation - */ - public function arrivalStation($arrivalStation) - { - return $this->setProperty('arrivalStation', $arrivalStation); - } - - /** - * The platform from which the train departs. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $departurePlatform + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/departurePlatform + * @see http://schema.org/additionalType */ - public function departurePlatform($departurePlatform) + public function additionalType($additionalType) { - return $this->setProperty('departurePlatform', $departurePlatform); + return $this->setProperty('additionalType', $additionalType); } /** - * The station from which the train departs. + * An alias for the item. * - * @param TrainStation|TrainStation[] $departureStation + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/departureStation + * @see http://schema.org/alternateName */ - public function departureStation($departureStation) + public function alternateName($alternateName) { - return $this->setProperty('departureStation', $departureStation); + return $this->setProperty('alternateName', $alternateName); } /** - * The name of the train (e.g. The Orient Express). + * The platform where the train arrives. * - * @param string|string[] $trainName + * @param string|string[] $arrivalPlatform * * @return static * - * @see http://schema.org/trainName + * @see http://schema.org/arrivalPlatform */ - public function trainName($trainName) + public function arrivalPlatform($arrivalPlatform) { - return $this->setProperty('trainName', $trainName); + return $this->setProperty('arrivalPlatform', $arrivalPlatform); } /** - * The unique identifier for the train. + * The station where the train trip ends. * - * @param string|string[] $trainNumber + * @param TrainStation|TrainStation[] $arrivalStation * * @return static * - * @see http://schema.org/trainNumber + * @see http://schema.org/arrivalStation */ - public function trainNumber($trainNumber) + public function arrivalStation($arrivalStation) { - return $this->setProperty('trainNumber', $trainNumber); + return $this->setProperty('arrivalStation', $arrivalStation); } /** @@ -113,82 +90,45 @@ public function arrivalTime($arrivalTime) } /** - * The expected departure time. - * - * @param \DateTimeInterface|\DateTimeInterface[] $departureTime - * - * @return static - * - * @see http://schema.org/departureTime - */ - public function departureTime($departureTime) - { - return $this->setProperty('departureTime', $departureTime); - } - - /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. - * - * @param Offer|Offer[] $offers - * - * @return static - * - * @see http://schema.org/offers - */ - public function offers($offers) - { - return $this->setProperty('offers', $offers); - } - - /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * The platform from which the train departs. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param string|string[] $departurePlatform * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/departurePlatform */ - public function provider($provider) + public function departurePlatform($departurePlatform) { - return $this->setProperty('provider', $provider); + return $this->setProperty('departurePlatform', $departurePlatform); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The station from which the train departs. * - * @param string|string[] $additionalType + * @param TrainStation|TrainStation[] $departureStation * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/departureStation */ - public function additionalType($additionalType) + public function departureStation($departureStation) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('departureStation', $departureStation); } /** - * An alias for the item. + * The expected departure time. * - * @param string|string[] $alternateName + * @param \DateTimeInterface|\DateTimeInterface[] $departureTime * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/departureTime */ - public function alternateName($alternateName) + public function departureTime($departureTime) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('departureTime', $departureTime); } /** @@ -285,6 +225,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -300,6 +256,22 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + /** * 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 @@ -330,6 +302,34 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The name of the train (e.g. The Orient Express). + * + * @param string|string[] $trainName + * + * @return static + * + * @see http://schema.org/trainName + */ + public function trainName($trainName) + { + return $this->setProperty('trainName', $trainName); + } + + /** + * The unique identifier for the train. + * + * @param string|string[] $trainNumber + * + * @return static + * + * @see http://schema.org/trainNumber + */ + public function trainNumber($trainNumber) + { + return $this->setProperty('trainNumber', $trainNumber); + } + /** * URL of the item. * diff --git a/src/TransferAction.php b/src/TransferAction.php index 88e9faa17..d4215f029 100644 --- a/src/TransferAction.php +++ b/src/TransferAction.php @@ -15,62 +15,96 @@ class TransferAction extends BaseType implements ActionContract, ThingContract { /** - * A sub property of location. The original location of the object or the - * agent before the action. + * Indicates the current disposition of the Action. * - * @param Place|Place[] $fromLocation + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/actionStatus */ - public function fromLocation($fromLocation) + public function actionStatus($actionStatus) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $toLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/additionalType */ - public function toLocation($toLocation) + public function additionalType($additionalType) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -111,288 +145,254 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Thing|Thing[] $object + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/object + * @see http://schema.org/fromLocation */ - public function object($object) + public function fromLocation($fromLocation) { - return $this->setProperty('object', $object); + return $this->setProperty('fromLocation', $fromLocation); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/TravelAction.php b/src/TravelAction.php index cefa80fba..e3b895145 100644 --- a/src/TravelAction.php +++ b/src/TravelAction.php @@ -16,76 +16,110 @@ class TravelAction extends BaseType implements MoveActionContract, ActionContract, ThingContract { /** - * The distance travelled, e.g. exercising or travelling. + * Indicates the current disposition of the Action. * - * @param Distance|Distance[] $distance + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/distance + * @see http://schema.org/actionStatus */ - public function distance($distance) + public function actionStatus($actionStatus) { - return $this->setProperty('distance', $distance); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of location. The original location of the object or the - * agent before the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Place|Place[] $fromLocation + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/fromLocation + * @see http://schema.org/additionalType */ - public function fromLocation($fromLocation) + public function additionalType($additionalType) { - return $this->setProperty('fromLocation', $fromLocation); + return $this->setProperty('additionalType', $additionalType); } /** - * A sub property of location. The final location of the object or the agent - * after the action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param Place|Place[] $toLocation + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/toLocation + * @see http://schema.org/agent */ - public function toLocation($toLocation) + public function agent($agent) { - return $this->setProperty('toLocation', $toLocation); + return $this->setProperty('agent', $agent); } /** - * Indicates the current disposition of the Action. + * An alias for the item. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/alternateName */ - public function actionStatus($actionStatus) + public function alternateName($alternateName) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('alternateName', $alternateName); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * A description of the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $description * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/description */ - public function agent($agent) + public function description($description) { - return $this->setProperty('agent', $agent); + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * The distance travelled, e.g. exercising or travelling. + * + * @param Distance|Distance[] $distance + * + * @return static + * + * @see http://schema.org/distance + */ + public function distance($distance) + { + return $this->setProperty('distance', $distance); } /** @@ -126,288 +160,254 @@ public function error($error) } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. - * - * @param Thing|Thing[] $instrument - * - * @return static - * - * @see http://schema.org/instrument - */ - public function instrument($instrument) - { - return $this->setProperty('instrument', $instrument); - } - - /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. - * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location - * - * @return static - * - * @see http://schema.org/location - */ - public function location($location) - { - return $this->setProperty('location', $location); - } - - /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * A sub property of location. The original location of the object or the + * agent before the action. * - * @param Thing|Thing[] $object + * @param Place|Place[] $fromLocation * * @return static * - * @see http://schema.org/object + * @see http://schema.org/fromLocation */ - public function object($object) + public function fromLocation($fromLocation) { - return $this->setProperty('object', $object); + return $this->setProperty('fromLocation', $fromLocation); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of location. The final location of the object or the agent + * after the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Place|Place[] $toLocation * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/toLocation */ - public function subjectOf($subjectOf) + public function toLocation($toLocation) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('toLocation', $toLocation); } /** diff --git a/src/TravelAgency.php b/src/TravelAgency.php index 2175f78f8..9f8f92347 100644 --- a/src/TravelAgency.php +++ b/src/TravelAgency.php @@ -16,126 +16,104 @@ class TravelAgency extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -180,6 +158,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -223,6 +236,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -240,6 +318,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -426,22 +535,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -471,6 +608,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -487,6 +671,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -545,6 +744,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -559,6 +789,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -618,6 +890,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -646,6 +932,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -676,664 +1005,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/Trip.php b/src/Trip.php index 1abc14b7d..417cd2884 100644 --- a/src/Trip.php +++ b/src/Trip.php @@ -14,96 +14,64 @@ class Trip extends BaseType implements IntangibleContract, ThingContract { /** - * The expected arrival time. - * - * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime - * - * @return static - * - * @see http://schema.org/arrivalTime - */ - public function arrivalTime($arrivalTime) - { - return $this->setProperty('arrivalTime', $arrivalTime); - } - - /** - * The expected departure time. - * - * @param \DateTimeInterface|\DateTimeInterface[] $departureTime - * - * @return static - * - * @see http://schema.org/departureTime - */ - public function departureTime($departureTime) - { - return $this->setProperty('departureTime', $departureTime); - } - - /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Offer|Offer[] $offers + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/offers + * @see http://schema.org/additionalType */ - public function offers($offers) + public function additionalType($additionalType) { - return $this->setProperty('offers', $offers); + return $this->setProperty('additionalType', $additionalType); } /** - * The service provider, service operator, or service performer; the goods - * producer. Another party (a seller) may offer those services or goods on - * behalf of the provider. A provider may also serve as the seller. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $provider + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/provider + * @see http://schema.org/alternateName */ - public function provider($provider) + public function alternateName($alternateName) { - return $this->setProperty('provider', $provider); + return $this->setProperty('alternateName', $alternateName); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The expected arrival time. * - * @param string|string[] $additionalType + * @param \DateTimeInterface|\DateTimeInterface[] $arrivalTime * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/arrivalTime */ - public function additionalType($additionalType) + public function arrivalTime($arrivalTime) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('arrivalTime', $arrivalTime); } /** - * An alias for the item. + * The expected departure time. * - * @param string|string[] $alternateName + * @param \DateTimeInterface|\DateTimeInterface[] $departureTime * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/departureTime */ - public function alternateName($alternateName) + public function departureTime($departureTime) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('departureTime', $departureTime); } /** @@ -200,6 +168,22 @@ public function name($name) return $this->setProperty('name', $name); } + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. + * + * @param Offer|Offer[] $offers + * + * @return static + * + * @see http://schema.org/offers + */ + public function offers($offers) + { + return $this->setProperty('offers', $offers); + } + /** * Indicates a potential Action, which describes an idealized action in * which this thing would play an 'object' role. @@ -215,6 +199,22 @@ public function potentialAction($potentialAction) return $this->setProperty('potentialAction', $potentialAction); } + /** + * The service provider, service operator, or service performer; the goods + * producer. Another party (a seller) may offer those services or goods on + * behalf of the provider. A provider may also serve as the seller. + * + * @param Organization|Organization[]|Person|Person[] $provider + * + * @return static + * + * @see http://schema.org/provider + */ + public function provider($provider) + { + return $this->setProperty('provider', $provider); + } + /** * 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 diff --git a/src/TypeAndQuantityNode.php b/src/TypeAndQuantityNode.php index 1d2acfc24..d411d7165 100644 --- a/src/TypeAndQuantityNode.php +++ b/src/TypeAndQuantityNode.php @@ -16,112 +16,66 @@ class TypeAndQuantityNode extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { /** - * The quantity of the goods included in the offer. - * - * @param float|float[]|int|int[] $amountOfThisGood - * - * @return static - * - * @see http://schema.org/amountOfThisGood - */ - public function amountOfThisGood($amountOfThisGood) - { - return $this->setProperty('amountOfThisGood', $amountOfThisGood); - } - - /** - * The business function (e.g. sell, lease, repair, dispose) of the offer or - * component of a bundle (TypeAndQuantityNode). The default is - * http://purl.org/goodrelations/v1#Sell. - * - * @param BusinessFunction|BusinessFunction[] $businessFunction - * - * @return static - * - * @see http://schema.org/businessFunction - */ - public function businessFunction($businessFunction) - { - return $this->setProperty('businessFunction', $businessFunction); - } - - /** - * The product that this structured value is referring to. - * - * @param Product|Product[]|Service|Service[] $typeOfGood - * - * @return static - * - * @see http://schema.org/typeOfGood - */ - public function typeOfGood($typeOfGood) - { - return $this->setProperty('typeOfGood', $typeOfGood); - } - - /** - * The unit of measurement given using the UN/CEFACT Common Code (3 - * characters) or a URL. Other codes than the UN/CEFACT Common Code may be - * used with a prefix followed by a colon. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $unitCode + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/unitCode + * @see http://schema.org/additionalType */ - public function unitCode($unitCode) + public function additionalType($additionalType) { - return $this->setProperty('unitCode', $unitCode); + return $this->setProperty('additionalType', $additionalType); } /** - * A string or text indicating the unit of measurement. Useful if you cannot - * provide a standard unit code for - * unitCode. + * An alias for the item. * - * @param string|string[] $unitText + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/unitText + * @see http://schema.org/alternateName */ - public function unitText($unitText) + public function alternateName($alternateName) { - return $this->setProperty('unitText', $unitText); + return $this->setProperty('alternateName', $alternateName); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The quantity of the goods included in the offer. * - * @param string|string[] $additionalType + * @param float|float[]|int|int[] $amountOfThisGood * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/amountOfThisGood */ - public function additionalType($additionalType) + public function amountOfThisGood($amountOfThisGood) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('amountOfThisGood', $amountOfThisGood); } /** - * An alias for the item. + * The business function (e.g. sell, lease, repair, dispose) of the offer or + * component of a bundle (TypeAndQuantityNode). The default is + * http://purl.org/goodrelations/v1#Sell. * - * @param string|string[] $alternateName + * @param BusinessFunction|BusinessFunction[] $businessFunction * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/businessFunction */ - public function alternateName($alternateName) + public function businessFunction($businessFunction) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('businessFunction', $businessFunction); } /** @@ -263,6 +217,52 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * The product that this structured value is referring to. + * + * @param Product|Product[]|Service|Service[] $typeOfGood + * + * @return static + * + * @see http://schema.org/typeOfGood + */ + public function typeOfGood($typeOfGood) + { + return $this->setProperty('typeOfGood', $typeOfGood); + } + + /** + * The unit of measurement given using the UN/CEFACT Common Code (3 + * characters) or a URL. Other codes than the UN/CEFACT Common Code may be + * used with a prefix followed by a colon. + * + * @param string|string[] $unitCode + * + * @return static + * + * @see http://schema.org/unitCode + */ + public function unitCode($unitCode) + { + return $this->setProperty('unitCode', $unitCode); + } + + /** + * A string or text indicating the unit of measurement. Useful if you cannot + * provide a standard unit code for + * unitCode. + * + * @param string|string[] $unitText + * + * @return static + * + * @see http://schema.org/unitText + */ + public function unitText($unitText) + { + return $this->setProperty('unitText', $unitText); + } + /** * URL of the item. * diff --git a/src/UnRegisterAction.php b/src/UnRegisterAction.php index cb9a77f78..89bab0a21 100644 --- a/src/UnRegisterAction.php +++ b/src/UnRegisterAction.php @@ -36,340 +36,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/UnitPriceSpecification.php b/src/UnitPriceSpecification.php index 9a6f9aba7..9f083fc7e 100644 --- a/src/UnitPriceSpecification.php +++ b/src/UnitPriceSpecification.php @@ -16,84 +16,83 @@ class UnitPriceSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract { /** - * This property specifies the minimal quantity and rounding increment that - * will be the basis for the billing. The unit of measurement is specified - * by the unitCode property. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param float|float[]|int|int[] $billingIncrement + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/billingIncrement + * @see http://schema.org/additionalType */ - public function billingIncrement($billingIncrement) + public function additionalType($additionalType) { - return $this->setProperty('billingIncrement', $billingIncrement); + return $this->setProperty('additionalType', $additionalType); } /** - * A short text or acronym indicating multiple price specifications for the - * same offer, e.g. SRP for the suggested retail price or INVOICE for the - * invoice price, mostly used in the car industry. + * An alias for the item. * - * @param string|string[] $priceType + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/priceType + * @see http://schema.org/alternateName */ - public function priceType($priceType) + public function alternateName($alternateName) { - return $this->setProperty('priceType', $priceType); + return $this->setProperty('alternateName', $alternateName); } /** - * The reference quantity for which a certain price applies, e.g. 1 EUR per - * 4 kWh of electricity. This property is a replacement for - * unitOfMeasurement for the advanced cases where the price does not relate - * to a standard unit. + * This property specifies the minimal quantity and rounding increment that + * will be the basis for the billing. The unit of measurement is specified + * by the unitCode property. * - * @param QuantitativeValue|QuantitativeValue[] $referenceQuantity + * @param float|float[]|int|int[] $billingIncrement * * @return static * - * @see http://schema.org/referenceQuantity + * @see http://schema.org/billingIncrement */ - public function referenceQuantity($referenceQuantity) + public function billingIncrement($billingIncrement) { - return $this->setProperty('referenceQuantity', $referenceQuantity); + return $this->setProperty('billingIncrement', $billingIncrement); } /** - * The unit of measurement given using the UN/CEFACT Common Code (3 - * characters) or a URL. Other codes than the UN/CEFACT Common Code may be - * used with a prefix followed by a colon. + * A description of the item. * - * @param string|string[] $unitCode + * @param string|string[] $description * * @return static * - * @see http://schema.org/unitCode + * @see http://schema.org/description */ - public function unitCode($unitCode) + public function description($description) { - return $this->setProperty('unitCode', $unitCode); + return $this->setProperty('description', $description); } /** - * A string or text indicating the unit of measurement. Useful if you cannot - * provide a standard unit code for - * unitCode. + * 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. * - * @param string|string[] $unitText + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/unitText + * @see http://schema.org/disambiguatingDescription */ - public function unitText($unitText) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('unitText', $unitText); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -129,6 +128,55 @@ public function eligibleTransactionVolume($eligibleTransactionVolume) return $this->setProperty('eligibleTransactionVolume', $eligibleTransactionVolume); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The highest price if the price is a range. * @@ -157,6 +205,35 @@ public function minPrice($minPrice) return $this->setProperty('minPrice', $minPrice); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The offer price of a product, or of a price component when attached to * PriceSpecification and its subtypes. @@ -218,233 +295,156 @@ public function priceCurrency($priceCurrency) } /** - * The date when the item becomes valid. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validFrom - * - * @return static - * - * @see http://schema.org/validFrom - */ - public function validFrom($validFrom) - { - return $this->setProperty('validFrom', $validFrom); - } - - /** - * The date after when the item is not valid. For example the end of an - * offer, salary period, or a period of opening hours. - * - * @param \DateTimeInterface|\DateTimeInterface[] $validThrough - * - * @return static - * - * @see http://schema.org/validThrough - */ - public function validThrough($validThrough) - { - return $this->setProperty('validThrough', $validThrough); - } - - /** - * Specifies whether the applicable value-added tax (VAT) is included in the - * price specification or not. - * - * @param bool|bool[] $valueAddedTaxIncluded - * - * @return static - * - * @see http://schema.org/valueAddedTaxIncluded - */ - public function valueAddedTaxIncluded($valueAddedTaxIncluded) - { - return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. + * A short text or acronym indicating multiple price specifications for the + * same offer, e.g. SRP for the suggested retail price or INVOICE for the + * invoice price, mostly used in the car industry. * - * @param string|string[] $description + * @param string|string[] $priceType * * @return static * - * @see http://schema.org/description + * @see http://schema.org/priceType */ - public function description($description) + public function priceType($priceType) { - return $this->setProperty('description', $description); + return $this->setProperty('priceType', $priceType); } /** - * 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. + * The reference quantity for which a certain price applies, e.g. 1 EUR per + * 4 kWh of electricity. This property is a replacement for + * unitOfMeasurement for the advanced cases where the price does not relate + * to a standard unit. * - * @param string|string[] $disambiguatingDescription + * @param QuantitativeValue|QuantitativeValue[] $referenceQuantity * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/referenceQuantity */ - public function disambiguatingDescription($disambiguatingDescription) + public function referenceQuantity($referenceQuantity) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('referenceQuantity', $referenceQuantity); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/sameAs */ - public function identifier($identifier) + public function sameAs($sameAs) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('sameAs', $sameAs); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/image + * @see http://schema.org/subjectOf */ - public function image($image) + public function subjectOf($subjectOf) { - return $this->setProperty('image', $image); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The unit of measurement given using the UN/CEFACT Common Code (3 + * characters) or a URL. Other codes than the UN/CEFACT Common Code may be + * used with a prefix followed by a colon. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $unitCode * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/unitCode */ - public function mainEntityOfPage($mainEntityOfPage) + public function unitCode($unitCode) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('unitCode', $unitCode); } /** - * The name of the item. + * A string or text indicating the unit of measurement. Useful if you cannot + * provide a standard unit code for + * unitCode. * - * @param string|string[] $name + * @param string|string[] $unitText * * @return static * - * @see http://schema.org/name + * @see http://schema.org/unitText */ - public function name($name) + public function unitText($unitText) { - return $this->setProperty('name', $name); + return $this->setProperty('unitText', $unitText); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * URL of the item. * - * @param Action|Action[] $potentialAction + * @param string|string[] $url * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/url */ - public function potentialAction($potentialAction) + public function url($url) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('url', $url); } /** - * 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. + * The date when the item becomes valid. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $validFrom * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/validFrom */ - public function sameAs($sameAs) + public function validFrom($validFrom) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('validFrom', $validFrom); } /** - * A CreativeWork or Event about this Thing. + * The date after when the item is not valid. For example the end of an + * offer, salary period, or a period of opening hours. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param \DateTimeInterface|\DateTimeInterface[] $validThrough * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/validThrough */ - public function subjectOf($subjectOf) + public function validThrough($validThrough) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('validThrough', $validThrough); } /** - * URL of the item. + * Specifies whether the applicable value-added tax (VAT) is included in the + * price specification or not. * - * @param string|string[] $url + * @param bool|bool[] $valueAddedTaxIncluded * * @return static * - * @see http://schema.org/url + * @see http://schema.org/valueAddedTaxIncluded */ - public function url($url) + public function valueAddedTaxIncluded($valueAddedTaxIncluded) { - return $this->setProperty('url', $url); + return $this->setProperty('valueAddedTaxIncluded', $valueAddedTaxIncluded); } } diff --git a/src/UpdateAction.php b/src/UpdateAction.php index 1041fcbd9..42a08ded2 100644 --- a/src/UpdateAction.php +++ b/src/UpdateAction.php @@ -14,382 +14,382 @@ class UpdateAction extends BaseType implements ActionContract, ThingContract { /** - * A sub property of object. The collection target of the action. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[] $collection + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/collection + * @see http://schema.org/actionStatus */ - public function collection($collection) + public function actionStatus($actionStatus) { - return $this->setProperty('collection', $collection); + return $this->setProperty('actionStatus', $actionStatus); } /** - * A sub property of object. The collection target of the action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[] $targetCollection + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/targetCollection + * @see http://schema.org/additionalType */ - public function targetCollection($targetCollection) + public function additionalType($additionalType) { - return $this->setProperty('targetCollection', $targetCollection); + return $this->setProperty('additionalType', $additionalType); } /** - * Indicates the current disposition of the Action. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/agent */ - public function actionStatus($actionStatus) + public function agent($agent) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('agent', $agent); } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * An alias for the item. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/alternateName */ - public function agent($agent) + public function alternateName($alternateName) { - return $this->setProperty('agent', $agent); + return $this->setProperty('alternateName', $alternateName); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * A sub property of object. The collection target of the action. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Thing|Thing[] $collection * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/collection */ - public function endTime($endTime) + public function collection($collection) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('collection', $collection); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $additionalType + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/mainEntityOfPage */ - public function additionalType($additionalType) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $description + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/description + * @see http://schema.org/object */ - public function description($description) + public function object($object) { - return $this->setProperty('description', $description); + return $this->setProperty('object', $object); } /** - * 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. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/participant */ - public function disambiguatingDescription($disambiguatingDescription) + public function participant($participant) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('participant', $participant); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/potentialAction */ - public function identifier($identifier) + public function potentialAction($potentialAction) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('potentialAction', $potentialAction); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The result produced in the action. e.g. John wrote *a book*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/image + * @see http://schema.org/result */ - public function image($image) + public function result($result) { - return $this->setProperty('image', $image); + return $this->setProperty('result', $result); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * 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. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/sameAs */ - public function mainEntityOfPage($mainEntityOfPage) + public function sameAs($sameAs) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('sameAs', $sameAs); } /** - * The name of the item. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $name + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/name + * @see http://schema.org/startTime */ - public function name($name) + public function startTime($startTime) { - return $this->setProperty('name', $name); + return $this->setProperty('startTime', $startTime); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * A CreativeWork or Event about this Thing. * - * @param Action|Action[] $potentialAction + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/subjectOf */ - public function potentialAction($potentialAction) + public function subjectOf($subjectOf) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. + * Indicates a target EntryPoint for an Action. * - * @param string|string[] $sameAs + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/target */ - public function sameAs($sameAs) + public function target($target) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('target', $target); } /** - * A CreativeWork or Event about this Thing. + * A sub property of object. The collection target of the action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Thing|Thing[] $targetCollection * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/targetCollection */ - public function subjectOf($subjectOf) + public function targetCollection($targetCollection) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('targetCollection', $targetCollection); } /** diff --git a/src/UseAction.php b/src/UseAction.php index f5427079e..a2ea79199 100644 --- a/src/UseAction.php +++ b/src/UseAction.php @@ -31,33 +31,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -76,325 +79,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/UserBlocks.php b/src/UserBlocks.php index 3bbc79c2c..4528306fe 100644 --- a/src/UserBlocks.php +++ b/src/UserBlocks.php @@ -46,6 +46,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -61,6 +80,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -132,6 +165,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -148,6 +195,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -222,6 +286,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -268,6 +365,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -282,6 +395,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -342,6 +469,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -402,6 +544,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -464,6 +622,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -510,6 +682,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -541,190 +727,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserCheckins.php b/src/UserCheckins.php index a225209f9..34358c8b9 100644 --- a/src/UserCheckins.php +++ b/src/UserCheckins.php @@ -46,6 +46,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -61,6 +80,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -132,6 +165,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -148,6 +195,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -222,6 +286,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -268,6 +365,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -282,6 +395,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -342,6 +469,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -402,6 +544,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -464,6 +622,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -510,6 +682,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -541,190 +727,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserComments.php b/src/UserComments.php index b2f72f1b0..577a8d451 100644 --- a/src/UserComments.php +++ b/src/UserComments.php @@ -17,161 +17,151 @@ class UserComments extends BaseType implements UserInteractionContract, EventContract, ThingContract { /** - * The text of the UserComment. - * - * @param string|string[] $commentText - * - * @return static - * - * @see http://schema.org/commentText - */ - public function commentText($commentText) - { - return $this->setProperty('commentText', $commentText); - } - - /** - * The time at which the UserComment was made. + * The subject matter of the content. * - * @param \DateTimeInterface|\DateTimeInterface[] $commentTime + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/commentTime + * @see http://schema.org/about */ - public function commentTime($commentTime) + public function about($about) { - return $this->setProperty('commentTime', $commentTime); + return $this->setProperty('about', $about); } /** - * The creator/author of this CreativeWork. This is the same as the Author - * property for CreativeWork. + * 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. * - * @param Organization|Organization[]|Person|Person[] $creator + * @param Person|Person[] $actor * * @return static * - * @see http://schema.org/creator + * @see http://schema.org/actor */ - public function creator($creator) + public function actor($actor) { - return $this->setProperty('creator', $creator); + return $this->setProperty('actor', $actor); } /** - * Specifies the CreativeWork associated with the UserComment. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param CreativeWork|CreativeWork[] $discusses + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/discusses + * @see http://schema.org/additionalType */ - public function discusses($discusses) + public function additionalType($additionalType) { - return $this->setProperty('discusses', $discusses); + return $this->setProperty('additionalType', $additionalType); } /** - * The URL at which a reply may be posted to the specified UserComment. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $replyToUrl + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/replyToUrl + * @see http://schema.org/aggregateRating */ - public function replyToUrl($replyToUrl) + public function aggregateRating($aggregateRating) { - return $this->setProperty('replyToUrl', $replyToUrl); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The subject matter of the content. + * An alias for the item. * - * @param Thing|Thing[] $about + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/about + * @see http://schema.org/alternateName */ - public function about($about) + public function alternateName($alternateName) { - return $this->setProperty('about', $about); + return $this->setProperty('alternateName', $alternateName); } /** - * 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. + * A person or organization attending the event. * - * @param Person|Person[] $actor + * @param Organization|Organization[]|Person|Person[] $attendee * * @return static * - * @see http://schema.org/actor + * @see http://schema.org/attendee */ - public function actor($actor) + public function attendee($attendee) { - return $this->setProperty('actor', $actor); + return $this->setProperty('attendee', $attendee); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A person attending the event. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param Organization|Organization[]|Person|Person[] $attendees * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/attendees */ - public function aggregateRating($aggregateRating) + public function attendees($attendees) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('attendees', $attendees); } /** - * A person or organization attending the event. + * An intended audience, i.e. a group for whom something was created. * - * @param Organization|Organization[]|Person|Person[] $attendee + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/attendee + * @see http://schema.org/audience */ - public function attendee($attendee) + public function audience($audience) { - return $this->setProperty('attendee', $attendee); + return $this->setProperty('audience', $audience); } /** - * A person attending the event. + * The text of the UserComment. * - * @param Organization|Organization[]|Person|Person[] $attendees + * @param string|string[] $commentText * * @return static * - * @see http://schema.org/attendees + * @see http://schema.org/commentText */ - public function attendees($attendees) + public function commentText($commentText) { - return $this->setProperty('attendees', $attendees); + return $this->setProperty('commentText', $commentText); } /** - * An intended audience, i.e. a group for whom something was created. + * The time at which the UserComment was made. * - * @param Audience|Audience[] $audience + * @param \DateTimeInterface|\DateTimeInterface[] $commentTime * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/commentTime */ - public function audience($audience) + public function commentTime($commentTime) { - return $this->setProperty('audience', $audience); + return $this->setProperty('commentTime', $commentTime); } /** @@ -203,6 +193,35 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. + * + * @param Organization|Organization[]|Person|Person[] $creator + * + * @return static + * + * @see http://schema.org/creator + */ + public function creator($creator) + { + return $this->setProperty('creator', $creator); + } + + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -219,6 +238,37 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * Specifies the CreativeWork associated with the UserComment. + * + * @param CreativeWork|CreativeWork[] $discusses + * + * @return static + * + * @see http://schema.org/discusses + */ + public function discusses($discusses) + { + return $this->setProperty('discusses', $discusses); + } + /** * The time admission will commence. * @@ -293,6 +343,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -339,6 +422,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -353,6 +452,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -413,6 +526,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -459,6 +587,20 @@ public function remainingAttendeeCapacity($remainingAttendeeCapacity) return $this->setProperty('remainingAttendeeCapacity', $remainingAttendeeCapacity); } + /** + * The URL at which a reply may be posted to the specified UserComment. + * + * @param string|string[] $replyToUrl + * + * @return static + * + * @see http://schema.org/replyToUrl + */ + public function replyToUrl($replyToUrl) + { + return $this->setProperty('replyToUrl', $replyToUrl); + } + /** * A review of the item. * @@ -473,6 +615,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -535,6 +693,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -581,6 +753,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -612,190 +798,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserDownloads.php b/src/UserDownloads.php index 2c62407fe..76c0911e7 100644 --- a/src/UserDownloads.php +++ b/src/UserDownloads.php @@ -46,6 +46,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -61,6 +80,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -132,6 +165,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -148,6 +195,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -222,6 +286,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -268,6 +365,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -282,6 +395,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -342,6 +469,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -402,6 +544,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -464,6 +622,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -510,6 +682,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -541,190 +727,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserInteraction.php b/src/UserInteraction.php index ab3a66bef..aba5982ad 100644 --- a/src/UserInteraction.php +++ b/src/UserInteraction.php @@ -45,6 +45,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -60,6 +79,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -131,6 +164,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -147,6 +194,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -221,6 +285,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -267,6 +364,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -281,6 +394,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -341,6 +468,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -401,6 +543,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -463,6 +621,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -509,6 +681,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -540,190 +726,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserLikes.php b/src/UserLikes.php index c85a07bb9..c5bc826ef 100644 --- a/src/UserLikes.php +++ b/src/UserLikes.php @@ -46,6 +46,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -61,6 +80,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -132,6 +165,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -148,6 +195,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -222,6 +286,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -268,6 +365,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -282,6 +395,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -342,6 +469,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -402,6 +544,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -464,6 +622,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -510,6 +682,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -541,190 +727,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserPageVisits.php b/src/UserPageVisits.php index cdd5e3819..819fe9c4f 100644 --- a/src/UserPageVisits.php +++ b/src/UserPageVisits.php @@ -46,6 +46,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -61,6 +80,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -132,6 +165,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -148,6 +195,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -222,6 +286,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -268,6 +365,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -282,6 +395,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -342,6 +469,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -402,6 +544,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -464,6 +622,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -510,6 +682,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -541,190 +727,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserPlays.php b/src/UserPlays.php index 06c7125bb..6ebccf71d 100644 --- a/src/UserPlays.php +++ b/src/UserPlays.php @@ -46,6 +46,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -61,6 +80,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -132,6 +165,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -148,6 +195,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -222,6 +286,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -268,6 +365,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -282,6 +395,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -342,6 +469,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -402,6 +544,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -464,6 +622,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -510,6 +682,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -541,190 +727,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserPlusOnes.php b/src/UserPlusOnes.php index 5c0b4800b..8bd98b1ab 100644 --- a/src/UserPlusOnes.php +++ b/src/UserPlusOnes.php @@ -46,6 +46,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -61,6 +80,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -132,6 +165,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -148,6 +195,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -222,6 +286,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -268,6 +365,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -282,6 +395,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -342,6 +469,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -402,6 +544,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -464,6 +622,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -510,6 +682,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -541,190 +727,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/UserTweets.php b/src/UserTweets.php index 2d46b7320..0ab473a43 100644 --- a/src/UserTweets.php +++ b/src/UserTweets.php @@ -46,6 +46,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -61,6 +80,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -132,6 +165,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -148,6 +195,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -222,6 +286,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -268,6 +365,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -282,6 +395,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -342,6 +469,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -402,6 +544,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -464,6 +622,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -510,6 +682,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -541,190 +727,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Vehicle.php b/src/Vehicle.php index 04237dfb7..371e43622 100644 --- a/src/Vehicle.php +++ b/src/Vehicle.php @@ -15,549 +15,321 @@ class Vehicle extends BaseType implements ProductContract, ThingContract { /** - * The available volume for cargo or luggage. For automobiles, this is - * usually the trunk volume. - * - * Typical unit code(s): LTR for liters, FTQ for cubic foot/feet - * - * Note: You can use [[minValue]] and [[maxValue]] to indicate ranges. - * - * @param QuantitativeValue|QuantitativeValue[] $cargoVolume - * - * @return static - * - * @see http://schema.org/cargoVolume - */ - public function cargoVolume($cargoVolume) - { - return $this->setProperty('cargoVolume', $cargoVolume); - } - - /** - * The date of the first registration of the vehicle with the respective - * public authorities. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateVehicleFirstRegistered - * - * @return static - * - * @see http://schema.org/dateVehicleFirstRegistered - */ - public function dateVehicleFirstRegistered($dateVehicleFirstRegistered) - { - return $this->setProperty('dateVehicleFirstRegistered', $dateVehicleFirstRegistered); - } - - /** - * The drive wheel configuration, i.e. which roadwheels will receive torque - * from the vehicle's engine via the drivetrain. - * - * @param DriveWheelConfigurationValue|DriveWheelConfigurationValue[]|string|string[] $driveWheelConfiguration - * - * @return static - * - * @see http://schema.org/driveWheelConfiguration - */ - public function driveWheelConfiguration($driveWheelConfiguration) - { - return $this->setProperty('driveWheelConfiguration', $driveWheelConfiguration); - } - - /** - * The amount of fuel consumed for traveling a particular distance or - * temporal duration with the given vehicle (e.g. liters per 100 km). - * - * * Note 1: There are unfortunately no standard unit codes for liters per - * 100 km. Use [[unitText]] to indicate the unit of measurement, e.g. L/100 - * km. - * * Note 2: There are two ways of indicating the fuel consumption, - * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] - * (e.g. 30 miles per gallon). They are reciprocal. - * * Note 3: Often, the absolute value is useful only when related to - * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can - * use [[valueReference]] to link the value for the fuel consumption to - * another value. - * - * @param QuantitativeValue|QuantitativeValue[] $fuelConsumption - * - * @return static - * - * @see http://schema.org/fuelConsumption - */ - public function fuelConsumption($fuelConsumption) - { - return $this->setProperty('fuelConsumption', $fuelConsumption); - } - - /** - * The distance traveled per unit of fuel used; most commonly miles per - * gallon (mpg) or kilometers per liter (km/L). + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * * Note 1: There are unfortunately no standard unit codes for miles per - * gallon or kilometers per liter. Use [[unitText]] to indicate the unit of - * measurement, e.g. mpg or km/L. - * * Note 2: There are two ways of indicating the fuel consumption, - * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] - * (e.g. 30 miles per gallon). They are reciprocal. - * * Note 3: Often, the absolute value is useful only when related to - * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can - * use [[valueReference]] to link the value for the fuel economy to another - * value. + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param QuantitativeValue|QuantitativeValue[] $fuelEfficiency + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/fuelEfficiency + * @see http://schema.org/additionalProperty */ - public function fuelEfficiency($fuelEfficiency) + public function additionalProperty($additionalProperty) { - return $this->setProperty('fuelEfficiency', $fuelEfficiency); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * The type of fuel suitable for the engine or engines of the vehicle. If - * the vehicle has only one engine, this property can be attached directly - * to the vehicle. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param QualitativeValue|QualitativeValue[]|string|string[] $fuelType + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/fuelType + * @see http://schema.org/additionalType */ - public function fuelType($fuelType) + public function additionalType($additionalType) { - return $this->setProperty('fuelType', $fuelType); + return $this->setProperty('additionalType', $additionalType); } /** - * A textual description of known damages, both repaired and unrepaired. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $knownVehicleDamages + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/knownVehicleDamages + * @see http://schema.org/aggregateRating */ - public function knownVehicleDamages($knownVehicleDamages) + public function aggregateRating($aggregateRating) { - return $this->setProperty('knownVehicleDamages', $knownVehicleDamages); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The total distance travelled by the particular vehicle since its initial - * production, as read from its odometer. - * - * Typical unit code(s): KMT for kilometers, SMI for statute miles + * An alias for the item. * - * @param QuantitativeValue|QuantitativeValue[] $mileageFromOdometer + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/mileageFromOdometer + * @see http://schema.org/alternateName */ - public function mileageFromOdometer($mileageFromOdometer) + public function alternateName($alternateName) { - return $this->setProperty('mileageFromOdometer', $mileageFromOdometer); + return $this->setProperty('alternateName', $alternateName); } /** - * The number or type of airbags in the vehicle. + * An intended audience, i.e. a group for whom something was created. * - * @param float|float[]|int|int[]|string|string[] $numberOfAirbags + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/numberOfAirbags + * @see http://schema.org/audience */ - public function numberOfAirbags($numberOfAirbags) + public function audience($audience) { - return $this->setProperty('numberOfAirbags', $numberOfAirbags); + return $this->setProperty('audience', $audience); } /** - * The number of axles. - * - * Typical unit code(s): C62 + * An award won by or for this item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfAxles + * @param string|string[] $award * * @return static * - * @see http://schema.org/numberOfAxles + * @see http://schema.org/award */ - public function numberOfAxles($numberOfAxles) + public function award($award) { - return $this->setProperty('numberOfAxles', $numberOfAxles); + return $this->setProperty('award', $award); } /** - * The number of doors. - * - * Typical unit code(s): C62 + * Awards won by or for this item. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfDoors + * @param string|string[] $awards * * @return static * - * @see http://schema.org/numberOfDoors + * @see http://schema.org/awards */ - public function numberOfDoors($numberOfDoors) + public function awards($awards) { - return $this->setProperty('numberOfDoors', $numberOfDoors); + return $this->setProperty('awards', $awards); } /** - * The total number of forward gears available for the transmission system - * of the vehicle. - * - * Typical unit code(s): C62 + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfForwardGears + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/numberOfForwardGears + * @see http://schema.org/brand */ - public function numberOfForwardGears($numberOfForwardGears) + public function brand($brand) { - return $this->setProperty('numberOfForwardGears', $numberOfForwardGears); + return $this->setProperty('brand', $brand); } /** - * The number of owners of the vehicle, including the current one. + * The available volume for cargo or luggage. For automobiles, this is + * usually the trunk volume. * - * Typical unit code(s): C62 - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfPreviousOwners - * - * @return static - * - * @see http://schema.org/numberOfPreviousOwners - */ - public function numberOfPreviousOwners($numberOfPreviousOwners) - { - return $this->setProperty('numberOfPreviousOwners', $numberOfPreviousOwners); - } - - /** - * The date of production of the item, e.g. vehicle. - * - * @param \DateTimeInterface|\DateTimeInterface[] $productionDate - * - * @return static - * - * @see http://schema.org/productionDate - */ - public function productionDate($productionDate) - { - return $this->setProperty('productionDate', $productionDate); - } - - /** - * The date the item e.g. vehicle was purchased by the current owner. - * - * @param \DateTimeInterface|\DateTimeInterface[] $purchaseDate - * - * @return static - * - * @see http://schema.org/purchaseDate - */ - public function purchaseDate($purchaseDate) - { - return $this->setProperty('purchaseDate', $purchaseDate); - } - - /** - * The position of the steering wheel or similar device (mostly for cars). - * - * @param SteeringPositionValue|SteeringPositionValue[] $steeringPosition - * - * @return static - * - * @see http://schema.org/steeringPosition - */ - public function steeringPosition($steeringPosition) - { - return $this->setProperty('steeringPosition', $steeringPosition); - } - - /** - * A short text indicating the configuration of the vehicle, e.g. '5dr - * hatchback ST 2.5 MT 225 hp' or 'limited edition'. - * - * @param string|string[] $vehicleConfiguration - * - * @return static - * - * @see http://schema.org/vehicleConfiguration - */ - public function vehicleConfiguration($vehicleConfiguration) - { - return $this->setProperty('vehicleConfiguration', $vehicleConfiguration); - } - - /** - * Information about the engine or engines of the vehicle. - * - * @param EngineSpecification|EngineSpecification[] $vehicleEngine - * - * @return static - * - * @see http://schema.org/vehicleEngine - */ - public function vehicleEngine($vehicleEngine) - { - return $this->setProperty('vehicleEngine', $vehicleEngine); - } - - /** - * The Vehicle Identification Number (VIN) is a unique serial number used by - * the automotive industry to identify individual motor vehicles. - * - * @param string|string[] $vehicleIdentificationNumber - * - * @return static - * - * @see http://schema.org/vehicleIdentificationNumber - */ - public function vehicleIdentificationNumber($vehicleIdentificationNumber) - { - return $this->setProperty('vehicleIdentificationNumber', $vehicleIdentificationNumber); - } - - /** - * The color or color combination of the interior of the vehicle. - * - * @param string|string[] $vehicleInteriorColor - * - * @return static - * - * @see http://schema.org/vehicleInteriorColor - */ - public function vehicleInteriorColor($vehicleInteriorColor) - { - return $this->setProperty('vehicleInteriorColor', $vehicleInteriorColor); - } - - /** - * The type or material of the interior of the vehicle (e.g. synthetic - * fabric, leather, wood, etc.). While most interior types are characterized - * by the material used, an interior type can also be based on vehicle usage - * or target audience. - * - * @param string|string[] $vehicleInteriorType - * - * @return static - * - * @see http://schema.org/vehicleInteriorType - */ - public function vehicleInteriorType($vehicleInteriorType) - { - return $this->setProperty('vehicleInteriorType', $vehicleInteriorType); - } - - /** - * The release date of a vehicle model (often used to differentiate versions - * of the same make and model). - * - * @param \DateTimeInterface|\DateTimeInterface[] $vehicleModelDate - * - * @return static - * - * @see http://schema.org/vehicleModelDate - */ - public function vehicleModelDate($vehicleModelDate) - { - return $this->setProperty('vehicleModelDate', $vehicleModelDate); - } - - /** - * The number of passengers that can be seated in the vehicle, both in terms - * of the physical space available, and in terms of limitations set by law. + * Typical unit code(s): LTR for liters, FTQ for cubic foot/feet * - * Typical unit code(s): C62 for persons. - * - * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $vehicleSeatingCapacity - * - * @return static - * - * @see http://schema.org/vehicleSeatingCapacity - */ - public function vehicleSeatingCapacity($vehicleSeatingCapacity) - { - return $this->setProperty('vehicleSeatingCapacity', $vehicleSeatingCapacity); - } - - /** - * Indicates whether the vehicle has been used for special purposes, like - * commercial rental, driving school, or as a taxi. The legislation in many - * countries requires this information to be revealed when offering a car - * for sale. + * Note: You can use [[minValue]] and [[maxValue]] to indicate ranges. * - * @param string|string[] $vehicleSpecialUsage + * @param QuantitativeValue|QuantitativeValue[] $cargoVolume * * @return static * - * @see http://schema.org/vehicleSpecialUsage + * @see http://schema.org/cargoVolume */ - public function vehicleSpecialUsage($vehicleSpecialUsage) + public function cargoVolume($cargoVolume) { - return $this->setProperty('vehicleSpecialUsage', $vehicleSpecialUsage); + return $this->setProperty('cargoVolume', $cargoVolume); } /** - * The type of component used for transmitting the power from a rotating - * power source to the wheels or other relevant component(s) ("gearbox" for - * cars). + * A category for the item. Greater signs or slashes can be used to + * informally indicate a category hierarchy. * - * @param QualitativeValue|QualitativeValue[]|string|string[] $vehicleTransmission + * @param Thing|Thing[]|string|string[] $category * * @return static * - * @see http://schema.org/vehicleTransmission + * @see http://schema.org/category */ - public function vehicleTransmission($vehicleTransmission) + public function category($category) { - return $this->setProperty('vehicleTransmission', $vehicleTransmission); + return $this->setProperty('category', $category); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The color of the product. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $color * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/color */ - public function additionalProperty($additionalProperty) + public function color($color) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('color', $color); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The date of the first registration of the vehicle with the respective + * public authorities. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param \DateTimeInterface|\DateTimeInterface[] $dateVehicleFirstRegistered * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/dateVehicleFirstRegistered */ - public function aggregateRating($aggregateRating) + public function dateVehicleFirstRegistered($dateVehicleFirstRegistered) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('dateVehicleFirstRegistered', $dateVehicleFirstRegistered); } /** - * An intended audience, i.e. a group for whom something was created. + * The depth of the item. * - * @param Audience|Audience[] $audience + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/depth */ - public function audience($audience) + public function depth($depth) { - return $this->setProperty('audience', $audience); + return $this->setProperty('depth', $depth); } /** - * An award won by or for this item. + * A description of the item. * - * @param string|string[] $award + * @param string|string[] $description * * @return static * - * @see http://schema.org/award + * @see http://schema.org/description */ - public function award($award) + public function description($description) { - return $this->setProperty('award', $award); + return $this->setProperty('description', $description); } /** - * Awards won by or for this item. + * 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. * - * @param string|string[] $awards + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/disambiguatingDescription */ - public function awards($awards) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('awards', $awards); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The drive wheel configuration, i.e. which roadwheels will receive torque + * from the vehicle's engine via the drivetrain. * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param DriveWheelConfigurationValue|DriveWheelConfigurationValue[]|string|string[] $driveWheelConfiguration * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/driveWheelConfiguration */ - public function brand($brand) + public function driveWheelConfiguration($driveWheelConfiguration) { - return $this->setProperty('brand', $brand); + return $this->setProperty('driveWheelConfiguration', $driveWheelConfiguration); } /** - * A category for the item. Greater signs or slashes can be used to - * informally indicate a category hierarchy. + * The amount of fuel consumed for traveling a particular distance or + * temporal duration with the given vehicle (e.g. liters per 100 km). + * + * * Note 1: There are unfortunately no standard unit codes for liters per + * 100 km. Use [[unitText]] to indicate the unit of measurement, e.g. L/100 + * km. + * * Note 2: There are two ways of indicating the fuel consumption, + * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] + * (e.g. 30 miles per gallon). They are reciprocal. + * * Note 3: Often, the absolute value is useful only when related to + * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can + * use [[valueReference]] to link the value for the fuel consumption to + * another value. * - * @param Thing|Thing[]|string|string[] $category + * @param QuantitativeValue|QuantitativeValue[] $fuelConsumption * * @return static * - * @see http://schema.org/category + * @see http://schema.org/fuelConsumption */ - public function category($category) + public function fuelConsumption($fuelConsumption) { - return $this->setProperty('category', $category); + return $this->setProperty('fuelConsumption', $fuelConsumption); } /** - * The color of the product. + * The distance traveled per unit of fuel used; most commonly miles per + * gallon (mpg) or kilometers per liter (km/L). + * + * * Note 1: There are unfortunately no standard unit codes for miles per + * gallon or kilometers per liter. Use [[unitText]] to indicate the unit of + * measurement, e.g. mpg or km/L. + * * Note 2: There are two ways of indicating the fuel consumption, + * [[fuelConsumption]] (e.g. 8 liters per 100 km) and [[fuelEfficiency]] + * (e.g. 30 miles per gallon). They are reciprocal. + * * Note 3: Often, the absolute value is useful only when related to + * driving speed ("at 80 km/h") or usage pattern ("city traffic"). You can + * use [[valueReference]] to link the value for the fuel economy to another + * value. * - * @param string|string[] $color + * @param QuantitativeValue|QuantitativeValue[] $fuelEfficiency * * @return static * - * @see http://schema.org/color + * @see http://schema.org/fuelEfficiency */ - public function color($color) + public function fuelEfficiency($fuelEfficiency) { - return $this->setProperty('color', $color); + return $this->setProperty('fuelEfficiency', $fuelEfficiency); } /** - * The depth of the item. + * The type of fuel suitable for the engine or engines of the vehicle. If + * the vehicle has only one engine, this property can be attached directly + * to the vehicle. * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $depth + * @param QualitativeValue|QualitativeValue[]|string|string[] $fuelType * * @return static * - * @see http://schema.org/depth + * @see http://schema.org/fuelType */ - public function depth($depth) + public function fuelType($fuelType) { - return $this->setProperty('depth', $depth); + return $this->setProperty('fuelType', $fuelType); } /** @@ -647,6 +419,39 @@ public function height($height) return $this->setProperty('height', $height); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A pointer to another product (or multiple products) for which this * product is an accessory or spare part. @@ -722,6 +527,20 @@ public function itemCondition($itemCondition) return $this->setProperty('itemCondition', $itemCondition); } + /** + * A textual description of known damages, both repaired and unrepaired. + * + * @param string|string[] $knownVehicleDamages + * + * @return static + * + * @see http://schema.org/knownVehicleDamages + */ + public function knownVehicleDamages($knownVehicleDamages) + { + return $this->setProperty('knownVehicleDamages', $knownVehicleDamages); + } + /** * An associated logo. * @@ -736,66 +555,192 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The manufacturer of the product. * - * @param Organization|Organization[] $manufacturer + * @param Organization|Organization[] $manufacturer + * + * @return static + * + * @see http://schema.org/manufacturer + */ + public function manufacturer($manufacturer) + { + return $this->setProperty('manufacturer', $manufacturer); + } + + /** + * A material that something is made from, e.g. leather, wool, cotton, + * paper. + * + * @param Product|Product[]|string|string[] $material + * + * @return static + * + * @see http://schema.org/material + */ + public function material($material) + { + return $this->setProperty('material', $material); + } + + /** + * The total distance travelled by the particular vehicle since its initial + * production, as read from its odometer. + * + * Typical unit code(s): KMT for kilometers, SMI for statute miles + * + * @param QuantitativeValue|QuantitativeValue[] $mileageFromOdometer + * + * @return static + * + * @see http://schema.org/mileageFromOdometer + */ + public function mileageFromOdometer($mileageFromOdometer) + { + return $this->setProperty('mileageFromOdometer', $mileageFromOdometer); + } + + /** + * The model of the product. Use with the URL of a ProductModel or a textual + * representation of the model identifier. The URL of the ProductModel can + * be from an external source. It is recommended to additionally provide + * strong product identifiers via the gtin8/gtin13/gtin14 and mpn + * properties. + * + * @param ProductModel|ProductModel[]|string|string[] $model + * + * @return static + * + * @see http://schema.org/model + */ + public function model($model) + { + return $this->setProperty('model', $model); + } + + /** + * The Manufacturer Part Number (MPN) of the product, or the product to + * which the offer refers. + * + * @param string|string[] $mpn + * + * @return static + * + * @see http://schema.org/mpn + */ + public function mpn($mpn) + { + return $this->setProperty('mpn', $mpn); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number or type of airbags in the vehicle. + * + * @param float|float[]|int|int[]|string|string[] $numberOfAirbags + * + * @return static + * + * @see http://schema.org/numberOfAirbags + */ + public function numberOfAirbags($numberOfAirbags) + { + return $this->setProperty('numberOfAirbags', $numberOfAirbags); + } + + /** + * The number of axles. + * + * Typical unit code(s): C62 + * + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfAxles * * @return static * - * @see http://schema.org/manufacturer + * @see http://schema.org/numberOfAxles */ - public function manufacturer($manufacturer) + public function numberOfAxles($numberOfAxles) { - return $this->setProperty('manufacturer', $manufacturer); + return $this->setProperty('numberOfAxles', $numberOfAxles); } /** - * A material that something is made from, e.g. leather, wool, cotton, - * paper. + * The number of doors. + * + * Typical unit code(s): C62 * - * @param Product|Product[]|string|string[] $material + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfDoors * * @return static * - * @see http://schema.org/material + * @see http://schema.org/numberOfDoors */ - public function material($material) + public function numberOfDoors($numberOfDoors) { - return $this->setProperty('material', $material); + return $this->setProperty('numberOfDoors', $numberOfDoors); } /** - * The model of the product. Use with the URL of a ProductModel or a textual - * representation of the model identifier. The URL of the ProductModel can - * be from an external source. It is recommended to additionally provide - * strong product identifiers via the gtin8/gtin13/gtin14 and mpn - * properties. + * The total number of forward gears available for the transmission system + * of the vehicle. + * + * Typical unit code(s): C62 * - * @param ProductModel|ProductModel[]|string|string[] $model + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfForwardGears * * @return static * - * @see http://schema.org/model + * @see http://schema.org/numberOfForwardGears */ - public function model($model) + public function numberOfForwardGears($numberOfForwardGears) { - return $this->setProperty('model', $model); + return $this->setProperty('numberOfForwardGears', $numberOfForwardGears); } /** - * The Manufacturer Part Number (MPN) of the product, or the product to - * which the offer refers. + * The number of owners of the vehicle, including the current one. + * + * Typical unit code(s): C62 * - * @param string|string[] $mpn + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $numberOfPreviousOwners * * @return static * - * @see http://schema.org/mpn + * @see http://schema.org/numberOfPreviousOwners */ - public function mpn($mpn) + public function numberOfPreviousOwners($numberOfPreviousOwners) { - return $this->setProperty('mpn', $mpn); + return $this->setProperty('numberOfPreviousOwners', $numberOfPreviousOwners); } /** @@ -814,6 +759,21 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The product identifier, such as ISBN. For example: ``` meta * itemprop="productID" content="isbn:123-456-789" ```. @@ -900,6 +860,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a * product or service, or the product to which the offer refers. @@ -930,217 +906,213 @@ public function slogan($slogan) } /** - * The weight of the product or person. + * The position of the steering wheel or similar device (mostly for cars). * - * @param QuantitativeValue|QuantitativeValue[] $weight + * @param SteeringPositionValue|SteeringPositionValue[] $steeringPosition * * @return static * - * @see http://schema.org/weight + * @see http://schema.org/steeringPosition */ - public function weight($weight) + public function steeringPosition($steeringPosition) { - return $this->setProperty('weight', $weight); + return $this->setProperty('steeringPosition', $steeringPosition); } /** - * The width of the item. + * A CreativeWork or Event about this Thing. * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/width + * @see http://schema.org/subjectOf */ - public function width($width) + public function subjectOf($subjectOf) { - return $this->setProperty('width', $width); + return $this->setProperty('subjectOf', $subjectOf); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * URL of the item. * - * @param string|string[] $additionalType + * @param string|string[] $url * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/url */ - public function additionalType($additionalType) + public function url($url) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('url', $url); } /** - * An alias for the item. + * A short text indicating the configuration of the vehicle, e.g. '5dr + * hatchback ST 2.5 MT 225 hp' or 'limited edition'. * - * @param string|string[] $alternateName + * @param string|string[] $vehicleConfiguration * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/vehicleConfiguration */ - public function alternateName($alternateName) + public function vehicleConfiguration($vehicleConfiguration) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('vehicleConfiguration', $vehicleConfiguration); } /** - * A description of the item. + * Information about the engine or engines of the vehicle. * - * @param string|string[] $description + * @param EngineSpecification|EngineSpecification[] $vehicleEngine * * @return static * - * @see http://schema.org/description + * @see http://schema.org/vehicleEngine */ - public function description($description) + public function vehicleEngine($vehicleEngine) { - return $this->setProperty('description', $description); + return $this->setProperty('vehicleEngine', $vehicleEngine); } /** - * 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. + * The Vehicle Identification Number (VIN) is a unique serial number used by + * the automotive industry to identify individual motor vehicles. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $vehicleIdentificationNumber * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/vehicleIdentificationNumber */ - public function disambiguatingDescription($disambiguatingDescription) + public function vehicleIdentificationNumber($vehicleIdentificationNumber) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('vehicleIdentificationNumber', $vehicleIdentificationNumber); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The color or color combination of the interior of the vehicle. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $vehicleInteriorColor * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/vehicleInteriorColor */ - public function identifier($identifier) + public function vehicleInteriorColor($vehicleInteriorColor) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('vehicleInteriorColor', $vehicleInteriorColor); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The type or material of the interior of the vehicle (e.g. synthetic + * fabric, leather, wood, etc.). While most interior types are characterized + * by the material used, an interior type can also be based on vehicle usage + * or target audience. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $vehicleInteriorType * * @return static * - * @see http://schema.org/image + * @see http://schema.org/vehicleInteriorType */ - public function image($image) + public function vehicleInteriorType($vehicleInteriorType) { - return $this->setProperty('image', $image); + return $this->setProperty('vehicleInteriorType', $vehicleInteriorType); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The release date of a vehicle model (often used to differentiate versions + * of the same make and model). * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param \DateTimeInterface|\DateTimeInterface[] $vehicleModelDate * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/vehicleModelDate */ - public function mainEntityOfPage($mainEntityOfPage) + public function vehicleModelDate($vehicleModelDate) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('vehicleModelDate', $vehicleModelDate); } /** - * The name of the item. + * The number of passengers that can be seated in the vehicle, both in terms + * of the physical space available, and in terms of limitations set by law. + * + * Typical unit code(s): C62 for persons. * - * @param string|string[] $name + * @param QuantitativeValue|QuantitativeValue[]|float|float[]|int|int[] $vehicleSeatingCapacity * * @return static * - * @see http://schema.org/name + * @see http://schema.org/vehicleSeatingCapacity */ - public function name($name) + public function vehicleSeatingCapacity($vehicleSeatingCapacity) { - return $this->setProperty('name', $name); + return $this->setProperty('vehicleSeatingCapacity', $vehicleSeatingCapacity); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Indicates whether the vehicle has been used for special purposes, like + * commercial rental, driving school, or as a taxi. The legislation in many + * countries requires this information to be revealed when offering a car + * for sale. * - * @param Action|Action[] $potentialAction + * @param string|string[] $vehicleSpecialUsage * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/vehicleSpecialUsage */ - public function potentialAction($potentialAction) + public function vehicleSpecialUsage($vehicleSpecialUsage) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('vehicleSpecialUsage', $vehicleSpecialUsage); } /** - * 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. + * The type of component used for transmitting the power from a rotating + * power source to the wheels or other relevant component(s) ("gearbox" for + * cars). * - * @param string|string[] $sameAs + * @param QualitativeValue|QualitativeValue[]|string|string[] $vehicleTransmission * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/vehicleTransmission */ - public function sameAs($sameAs) + public function vehicleTransmission($vehicleTransmission) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('vehicleTransmission', $vehicleTransmission); } /** - * A CreativeWork or Event about this Thing. + * The weight of the product or person. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param QuantitativeValue|QuantitativeValue[] $weight * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/weight */ - public function subjectOf($subjectOf) + public function weight($weight) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('weight', $weight); } /** - * URL of the item. + * The width of the item. * - * @param string|string[] $url + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/url + * @see http://schema.org/width */ - public function url($url) + public function width($width) { - return $this->setProperty('url', $url); + return $this->setProperty('width', $width); } } diff --git a/src/VideoGallery.php b/src/VideoGallery.php index ae55514a2..b6faf5958 100644 --- a/src/VideoGallery.php +++ b/src/VideoGallery.php @@ -15,176 +15,6 @@ */ class VideoGallery extends BaseType implements CollectionPageContract, WebPageContract, CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -329,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -344,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -445,6 +308,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -635,6 +513,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -861,13 +770,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -997,6 +939,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1042,6 +999,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1057,6 +1028,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1087,6 +1074,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1117,6 +1118,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1215,6 +1245,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1244,6 +1288,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1258,6 +1317,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1275,6 +1350,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1324,6 +1429,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1340,6 +1498,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1461,6 +1633,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1504,190 +1690,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/VideoGame.php b/src/VideoGame.php index 07629cd6b..ef67d1e6e 100644 --- a/src/VideoGame.php +++ b/src/VideoGame.php @@ -17,1210 +17,1118 @@ class VideoGame extends BaseType implements SoftwareApplicationContract, GameContract, CreativeWorkContract, ThingContract { /** - * 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. + * The subject matter of the content. * - * @param Person|Person[] $actor + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/actor + * @see http://schema.org/about */ - public function actor($actor) + public function about($about) { - return $this->setProperty('actor', $actor); + return $this->setProperty('about', $about); } /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. * - * @param Person|Person[] $actors + * @param string|string[] $accessMode * * @return static * - * @see http://schema.org/actors + * @see http://schema.org/accessMode */ - public function actors($actors) + public function accessMode($accessMode) { - return $this->setProperty('actors', $actors); + return $this->setProperty('accessMode', $accessMode); } /** - * Cheat codes to the game. + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. * - * @param CreativeWork|CreativeWork[] $cheatCode + * @param ItemList|ItemList[] $accessModeSufficient * * @return static * - * @see http://schema.org/cheatCode + * @see http://schema.org/accessModeSufficient */ - public function cheatCode($cheatCode) + public function accessModeSufficient($accessModeSufficient) { - return $this->setProperty('cheatCode', $cheatCode); + return $this->setProperty('accessModeSufficient', $accessModeSufficient); } /** - * 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. + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Person|Person[] $director + * @param string|string[] $accessibilityAPI * * @return static * - * @see http://schema.org/director + * @see http://schema.org/accessibilityAPI */ - public function director($director) + public function accessibilityAPI($accessibilityAPI) { - return $this->setProperty('director', $director); + return $this->setProperty('accessibilityAPI', $accessibilityAPI); } /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Person|Person[] $directors + * @param string|string[] $accessibilityControl * * @return static * - * @see http://schema.org/directors + * @see http://schema.org/accessibilityControl */ - public function directors($directors) + public function accessibilityControl($accessibilityControl) { - return $this->setProperty('directors', $directors); + return $this->setProperty('accessibilityControl', $accessibilityControl); } /** - * The electronic systems used to play video - * games. + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Thing|Thing[]|string|string[] $gamePlatform + * @param string|string[] $accessibilityFeature * * @return static * - * @see http://schema.org/gamePlatform + * @see http://schema.org/accessibilityFeature */ - public function gamePlatform($gamePlatform) + public function accessibilityFeature($accessibilityFeature) { - return $this->setProperty('gamePlatform', $gamePlatform); + return $this->setProperty('accessibilityFeature', $accessibilityFeature); } /** - * The server on which it is possible to play the game. + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param GameServer|GameServer[] $gameServer + * @param string|string[] $accessibilityHazard * * @return static * - * @see http://schema.org/gameServer + * @see http://schema.org/accessibilityHazard */ - public function gameServer($gameServer) + public function accessibilityHazard($accessibilityHazard) { - return $this->setProperty('gameServer', $gameServer); + return $this->setProperty('accessibilityHazard', $accessibilityHazard); } /** - * Links to tips, tactics, etc. + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." * - * @param CreativeWork|CreativeWork[] $gameTip + * @param string|string[] $accessibilitySummary * * @return static * - * @see http://schema.org/gameTip + * @see http://schema.org/accessibilitySummary */ - public function gameTip($gameTip) + public function accessibilitySummary($accessibilitySummary) { - return $this->setProperty('gameTip', $gameTip); + return $this->setProperty('accessibilitySummary', $accessibilitySummary); } /** - * The composer of the soundtrack. + * Specifies the Person that is legally accountable for the CreativeWork. * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * @param Person|Person[] $accountablePerson * * @return static * - * @see http://schema.org/musicBy + * @see http://schema.org/accountablePerson */ - public function musicBy($musicBy) + public function accountablePerson($accountablePerson) { - return $this->setProperty('musicBy', $musicBy); + return $this->setProperty('accountablePerson', $accountablePerson); } /** - * Indicates whether this game is multi-player, co-op or single-player. The - * game can be marked as multi-player, co-op and single-player at the same - * time. + * 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. * - * @param GamePlayMode|GamePlayMode[] $playMode + * @param Person|Person[] $actor * * @return static * - * @see http://schema.org/playMode + * @see http://schema.org/actor */ - public function playMode($playMode) + public function actor($actor) { - return $this->setProperty('playMode', $playMode); + return $this->setProperty('actor', $actor); } /** - * The trailer of a movie or tv/radio series, season, episode, etc. + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. * - * @param VideoObject|VideoObject[] $trailer + * @param Person|Person[] $actors * * @return static * - * @see http://schema.org/trailer + * @see http://schema.org/actors */ - public function trailer($trailer) + public function actors($actors) { - return $this->setProperty('trailer', $trailer); + return $this->setProperty('actors', $actors); } /** - * Type of software application, e.g. 'Game, Multimedia'. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $applicationCategory + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/applicationCategory + * @see http://schema.org/additionalType */ - public function applicationCategory($applicationCategory) + public function additionalType($additionalType) { - return $this->setProperty('applicationCategory', $applicationCategory); + return $this->setProperty('additionalType', $additionalType); } /** - * Subcategory of the application, e.g. 'Arcade Game'. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $applicationSubCategory + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/applicationSubCategory + * @see http://schema.org/aggregateRating */ - public function applicationSubCategory($applicationSubCategory) + public function aggregateRating($aggregateRating) { - return $this->setProperty('applicationSubCategory', $applicationSubCategory); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The name of the application suite to which the application belongs (e.g. - * Excel belongs to Office). + * An alias for the item. * - * @param string|string[] $applicationSuite + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/applicationSuite + * @see http://schema.org/alternateName */ - public function applicationSuite($applicationSuite) + public function alternateName($alternateName) { - return $this->setProperty('applicationSuite', $applicationSuite); + return $this->setProperty('alternateName', $alternateName); } /** - * Device required to run the application. Used in cases where a specific - * make/model is required to run the application. + * A secondary title of the CreativeWork. * - * @param string|string[] $availableOnDevice + * @param string|string[] $alternativeHeadline * * @return static * - * @see http://schema.org/availableOnDevice + * @see http://schema.org/alternativeHeadline */ - public function availableOnDevice($availableOnDevice) + public function alternativeHeadline($alternativeHeadline) { - return $this->setProperty('availableOnDevice', $availableOnDevice); + return $this->setProperty('alternativeHeadline', $alternativeHeadline); } /** - * Countries for which the application is not supported. You can also - * provide the two-letter ISO 3166-1 alpha-2 country code. + * Type of software application, e.g. 'Game, Multimedia'. * - * @param string|string[] $countriesNotSupported + * @param string|string[] $applicationCategory * * @return static * - * @see http://schema.org/countriesNotSupported + * @see http://schema.org/applicationCategory */ - public function countriesNotSupported($countriesNotSupported) + public function applicationCategory($applicationCategory) { - return $this->setProperty('countriesNotSupported', $countriesNotSupported); + return $this->setProperty('applicationCategory', $applicationCategory); } /** - * Countries for which the application is supported. You can also provide - * the two-letter ISO 3166-1 alpha-2 country code. + * Subcategory of the application, e.g. 'Arcade Game'. * - * @param string|string[] $countriesSupported + * @param string|string[] $applicationSubCategory * * @return static * - * @see http://schema.org/countriesSupported + * @see http://schema.org/applicationSubCategory */ - public function countriesSupported($countriesSupported) + public function applicationSubCategory($applicationSubCategory) { - return $this->setProperty('countriesSupported', $countriesSupported); + return $this->setProperty('applicationSubCategory', $applicationSubCategory); } /** - * Device required to run the application. Used in cases where a specific - * make/model is required to run the application. + * The name of the application suite to which the application belongs (e.g. + * Excel belongs to Office). * - * @param string|string[] $device + * @param string|string[] $applicationSuite * * @return static * - * @see http://schema.org/device + * @see http://schema.org/applicationSuite */ - public function device($device) + public function applicationSuite($applicationSuite) { - return $this->setProperty('device', $device); + return $this->setProperty('applicationSuite', $applicationSuite); } /** - * If the file can be downloaded, URL to download the binary. + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. * - * @param string|string[] $downloadUrl + * @param MediaObject|MediaObject[] $associatedMedia * * @return static * - * @see http://schema.org/downloadUrl + * @see http://schema.org/associatedMedia */ - public function downloadUrl($downloadUrl) + public function associatedMedia($associatedMedia) { - return $this->setProperty('downloadUrl', $downloadUrl); + return $this->setProperty('associatedMedia', $associatedMedia); } /** - * Features or modules provided by this application (and possibly required - * by other applications). + * An intended audience, i.e. a group for whom something was created. * - * @param string|string[] $featureList + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/featureList + * @see http://schema.org/audience */ - public function featureList($featureList) + public function audience($audience) { - return $this->setProperty('featureList', $featureList); + return $this->setProperty('audience', $audience); } /** - * Size of the application / package (e.g. 18MB). In the absence of a unit - * (MB, KB etc.), KB will be assumed. + * An embedded audio object. * - * @param string|string[] $fileSize + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio * * @return static * - * @see http://schema.org/fileSize + * @see http://schema.org/audio */ - public function fileSize($fileSize) + public function audio($audio) { - return $this->setProperty('fileSize', $fileSize); + return $this->setProperty('audio', $audio); } /** - * URL at which the app may be installed, if different from the URL of the - * item. + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. * - * @param string|string[] $installUrl + * @param Organization|Organization[]|Person|Person[] $author * * @return static * - * @see http://schema.org/installUrl + * @see http://schema.org/author */ - public function installUrl($installUrl) + public function author($author) { - return $this->setProperty('installUrl', $installUrl); + return $this->setProperty('author', $author); } /** - * Minimum memory requirements. + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. * - * @param string|string[] $memoryRequirements + * @param string|string[] $availableOnDevice * * @return static * - * @see http://schema.org/memoryRequirements + * @see http://schema.org/availableOnDevice */ - public function memoryRequirements($memoryRequirements) + public function availableOnDevice($availableOnDevice) { - return $this->setProperty('memoryRequirements', $memoryRequirements); + return $this->setProperty('availableOnDevice', $availableOnDevice); } /** - * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). + * An award won by or for this item. * - * @param string|string[] $operatingSystem + * @param string|string[] $award * * @return static * - * @see http://schema.org/operatingSystem + * @see http://schema.org/award */ - public function operatingSystem($operatingSystem) + public function award($award) { - return $this->setProperty('operatingSystem', $operatingSystem); + return $this->setProperty('award', $award); } /** - * Permission(s) required to run the app (for example, a mobile app may - * require full internet access or may run only on wifi). + * Awards won by or for this item. * - * @param string|string[] $permissions + * @param string|string[] $awards * * @return static * - * @see http://schema.org/permissions + * @see http://schema.org/awards */ - public function permissions($permissions) + public function awards($awards) { - return $this->setProperty('permissions', $permissions); + return $this->setProperty('awards', $awards); } /** - * Processor architecture required to run the application (e.g. IA64). + * Fictional person connected with a creative work. * - * @param string|string[] $processorRequirements + * @param Person|Person[] $character * * @return static * - * @see http://schema.org/processorRequirements + * @see http://schema.org/character */ - public function processorRequirements($processorRequirements) + public function character($character) { - return $this->setProperty('processorRequirements', $processorRequirements); + return $this->setProperty('character', $character); } /** - * Description of what changed in this version. + * A piece of data that represents a particular aspect of a fictional + * character (skill, power, character points, advantage, disadvantage). * - * @param string|string[] $releaseNotes + * @param Thing|Thing[] $characterAttribute * * @return static * - * @see http://schema.org/releaseNotes + * @see http://schema.org/characterAttribute */ - public function releaseNotes($releaseNotes) + public function characterAttribute($characterAttribute) { - return $this->setProperty('releaseNotes', $releaseNotes); + return $this->setProperty('characterAttribute', $characterAttribute); } /** - * Component dependency requirements for application. This includes runtime - * environments and shared libraries that are not included in the - * application distribution package, but required to run the application - * (Examples: DirectX, Java or .NET runtime). + * Cheat codes to the game. * - * @param string|string[] $requirements + * @param CreativeWork|CreativeWork[] $cheatCode * * @return static * - * @see http://schema.org/requirements + * @see http://schema.org/cheatCode */ - public function requirements($requirements) + public function cheatCode($cheatCode) { - return $this->setProperty('requirements', $requirements); + return $this->setProperty('cheatCode', $cheatCode); } /** - * A link to a screenshot image of the app. + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. * - * @param ImageObject|ImageObject[]|string|string[] $screenshot + * @param CreativeWork|CreativeWork[]|string|string[] $citation * * @return static * - * @see http://schema.org/screenshot + * @see http://schema.org/citation */ - public function screenshot($screenshot) + public function citation($citation) { - return $this->setProperty('screenshot', $screenshot); + return $this->setProperty('citation', $citation); } /** - * Additional content for a software application. + * Comments, typically from users. * - * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn + * @param Comment|Comment[] $comment * * @return static * - * @see http://schema.org/softwareAddOn + * @see http://schema.org/comment */ - public function softwareAddOn($softwareAddOn) + public function comment($comment) { - return $this->setProperty('softwareAddOn', $softwareAddOn); + return $this->setProperty('comment', $comment); } /** - * Software application help. + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. * - * @param CreativeWork|CreativeWork[] $softwareHelp + * @param int|int[] $commentCount * * @return static * - * @see http://schema.org/softwareHelp + * @see http://schema.org/commentCount */ - public function softwareHelp($softwareHelp) + public function commentCount($commentCount) { - return $this->setProperty('softwareHelp', $softwareHelp); + return $this->setProperty('commentCount', $commentCount); } /** - * Component dependency requirements for application. This includes runtime - * environments and shared libraries that are not included in the - * application distribution package, but required to run the application - * (Examples: DirectX, Java or .NET runtime). + * The location depicted or described in the content. For example, the + * location in a photograph or painting. * - * @param string|string[] $softwareRequirements + * @param Place|Place[] $contentLocation * * @return static * - * @see http://schema.org/softwareRequirements + * @see http://schema.org/contentLocation */ - public function softwareRequirements($softwareRequirements) + public function contentLocation($contentLocation) { - return $this->setProperty('softwareRequirements', $softwareRequirements); + return $this->setProperty('contentLocation', $contentLocation); } /** - * Version of the software instance. + * Official rating of a piece of content—for example,'MPAA PG-13'. * - * @param string|string[] $softwareVersion + * @param Rating|Rating[]|string|string[] $contentRating * * @return static * - * @see http://schema.org/softwareVersion + * @see http://schema.org/contentRating */ - public function softwareVersion($softwareVersion) + public function contentRating($contentRating) { - return $this->setProperty('softwareVersion', $softwareVersion); + return $this->setProperty('contentRating', $contentRating); } /** - * Storage requirements (free space required). + * A secondary contributor to the CreativeWork or Event. * - * @param string|string[] $storageRequirements + * @param Organization|Organization[]|Person|Person[] $contributor * * @return static * - * @see http://schema.org/storageRequirements + * @see http://schema.org/contributor */ - public function storageRequirements($storageRequirements) + public function contributor($contributor) { - return $this->setProperty('storageRequirements', $storageRequirements); + return $this->setProperty('contributor', $contributor); } /** - * Supporting data for a SoftwareApplication. + * The party holding the legal copyright to the CreativeWork. * - * @param DataFeed|DataFeed[] $supportingData + * @param Organization|Organization[]|Person|Person[] $copyrightHolder * * @return static * - * @see http://schema.org/supportingData + * @see http://schema.org/copyrightHolder */ - public function supportingData($supportingData) + public function copyrightHolder($copyrightHolder) { - return $this->setProperty('supportingData', $supportingData); + return $this->setProperty('copyrightHolder', $copyrightHolder); } /** - * The subject matter of the content. + * The year during which the claimed copyright for the CreativeWork was + * first asserted. * - * @param Thing|Thing[] $about + * @param float|float[]|int|int[] $copyrightYear * * @return static * - * @see http://schema.org/about + * @see http://schema.org/copyrightYear */ - public function about($about) + public function copyrightYear($copyrightYear) { - return $this->setProperty('about', $about); + return $this->setProperty('copyrightYear', $copyrightYear); } /** - * The human sensory perceptual system or cognitive faculty through which a - * person may process or perceive information. Expected values include: - * auditory, tactile, textual, visual, colorDependent, chartOnVisual, - * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * Countries for which the application is not supported. You can also + * provide the two-letter ISO 3166-1 alpha-2 country code. * - * @param string|string[] $accessMode + * @param string|string[] $countriesNotSupported * * @return static * - * @see http://schema.org/accessMode + * @see http://schema.org/countriesNotSupported */ - public function accessMode($accessMode) + public function countriesNotSupported($countriesNotSupported) { - return $this->setProperty('accessMode', $accessMode); + return $this->setProperty('countriesNotSupported', $countriesNotSupported); } /** - * A list of single or combined accessModes that are sufficient to - * understand all the intellectual content of a resource. Expected values - * include: auditory, tactile, textual, visual. + * Countries for which the application is supported. You can also provide + * the two-letter ISO 3166-1 alpha-2 country code. * - * @param ItemList|ItemList[] $accessModeSufficient + * @param string|string[] $countriesSupported * * @return static * - * @see http://schema.org/accessModeSufficient + * @see http://schema.org/countriesSupported */ - public function accessModeSufficient($accessModeSufficient) + public function countriesSupported($countriesSupported) { - return $this->setProperty('accessModeSufficient', $accessModeSufficient); + return $this->setProperty('countriesSupported', $countriesSupported); } /** - * Indicates that the resource is compatible with the referenced - * accessibility API ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. * - * @param string|string[] $accessibilityAPI + * @param Organization|Organization[]|Person|Person[] $creator * * @return static * - * @see http://schema.org/accessibilityAPI + * @see http://schema.org/creator */ - public function accessibilityAPI($accessibilityAPI) + public function creator($creator) { - return $this->setProperty('accessibilityAPI', $accessibilityAPI); + return $this->setProperty('creator', $creator); } /** - * Identifies input methods that are sufficient to fully control the - * described resource ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. * - * @param string|string[] $accessibilityControl + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated * * @return static * - * @see http://schema.org/accessibilityControl + * @see http://schema.org/dateCreated */ - public function accessibilityControl($accessibilityControl) + public function dateCreated($dateCreated) { - return $this->setProperty('accessibilityControl', $accessibilityControl); + return $this->setProperty('dateCreated', $dateCreated); } /** - * Content features of the resource, such as accessible media, alternatives - * and supported enhancements for accessibility ([WebSchemas wiki lists - * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. * - * @param string|string[] $accessibilityFeature + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified * * @return static * - * @see http://schema.org/accessibilityFeature + * @see http://schema.org/dateModified */ - public function accessibilityFeature($accessibilityFeature) + public function dateModified($dateModified) { - return $this->setProperty('accessibilityFeature', $accessibilityFeature); + return $this->setProperty('dateModified', $dateModified); } /** - * A characteristic of the described resource that is physiologically - * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas - * wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * Date of first broadcast/publication. * - * @param string|string[] $accessibilityHazard + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished * * @return static * - * @see http://schema.org/accessibilityHazard + * @see http://schema.org/datePublished */ - public function accessibilityHazard($accessibilityHazard) + public function datePublished($datePublished) { - return $this->setProperty('accessibilityHazard', $accessibilityHazard); + return $this->setProperty('datePublished', $datePublished); } /** - * A human-readable summary of specific accessibility features or - * deficiencies, consistent with the other accessibility metadata but - * expressing subtleties such as "short descriptions are present but long - * descriptions will be needed for non-visual users" or "short descriptions - * are present and no long descriptions are needed." + * A description of the item. * - * @param string|string[] $accessibilitySummary + * @param string|string[] $description * * @return static * - * @see http://schema.org/accessibilitySummary + * @see http://schema.org/description */ - public function accessibilitySummary($accessibilitySummary) + public function description($description) { - return $this->setProperty('accessibilitySummary', $accessibilitySummary); + return $this->setProperty('description', $description); } /** - * Specifies the Person that is legally accountable for the CreativeWork. + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. * - * @param Person|Person[] $accountablePerson + * @param string|string[] $device * * @return static * - * @see http://schema.org/accountablePerson + * @see http://schema.org/device */ - public function accountablePerson($accountablePerson) + public function device($device) { - return $this->setProperty('accountablePerson', $accountablePerson); + return $this->setProperty('device', $device); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/director */ - public function aggregateRating($aggregateRating) + public function director($director) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('director', $director); } /** - * A secondary title of the CreativeWork. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param string|string[] $alternativeHeadline + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/alternativeHeadline + * @see http://schema.org/directors */ - public function alternativeHeadline($alternativeHeadline) + public function directors($directors) { - return $this->setProperty('alternativeHeadline', $alternativeHeadline); + return $this->setProperty('directors', $directors); } /** - * A media object that encodes this CreativeWork. This property is a synonym - * for encoding. + * 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. * - * @param MediaObject|MediaObject[] $associatedMedia + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/associatedMedia + * @see http://schema.org/disambiguatingDescription */ - public function associatedMedia($associatedMedia) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('associatedMedia', $associatedMedia); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * An intended audience, i.e. a group for whom something was created. + * A link to the page containing the comments of the CreativeWork. * - * @param Audience|Audience[] $audience + * @param string|string[] $discussionUrl * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/discussionUrl */ - public function audience($audience) + public function discussionUrl($discussionUrl) { - return $this->setProperty('audience', $audience); + return $this->setProperty('discussionUrl', $discussionUrl); } /** - * An embedded audio object. + * If the file can be downloaded, URL to download the binary. * - * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * @param string|string[] $downloadUrl * * @return static * - * @see http://schema.org/audio + * @see http://schema.org/downloadUrl */ - public function audio($audio) + public function downloadUrl($downloadUrl) { - return $this->setProperty('audio', $audio); + return $this->setProperty('downloadUrl', $downloadUrl); } /** - * The author of this content or rating. Please note that author is special - * in that HTML 5 provides a special mechanism for indicating authorship via - * the rel tag. That is equivalent to this and may be used interchangeably. + * Specifies the Person who edited the CreativeWork. * - * @param Organization|Organization[]|Person|Person[] $author + * @param Person|Person[] $editor * * @return static * - * @see http://schema.org/author + * @see http://schema.org/editor */ - public function author($author) + public function editor($editor) { - return $this->setProperty('author', $author); + return $this->setProperty('editor', $editor); } /** - * An award won by or for this item. + * An alignment to an established educational framework. * - * @param string|string[] $award + * @param AlignmentObject|AlignmentObject[] $educationalAlignment * * @return static * - * @see http://schema.org/award + * @see http://schema.org/educationalAlignment */ - public function award($award) + public function educationalAlignment($educationalAlignment) { - return $this->setProperty('award', $award); + return $this->setProperty('educationalAlignment', $educationalAlignment); } /** - * Awards won by or for this item. + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. * - * @param string|string[] $awards + * @param string|string[] $educationalUse * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/educationalUse */ - public function awards($awards) + public function educationalUse($educationalUse) { - return $this->setProperty('awards', $awards); + return $this->setProperty('educationalUse', $educationalUse); } /** - * Fictional person connected with a creative work. + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. * - * @param Person|Person[] $character + * @param MediaObject|MediaObject[] $encoding * * @return static * - * @see http://schema.org/character + * @see http://schema.org/encoding */ - public function character($character) + public function encoding($encoding) { - return $this->setProperty('character', $character); + return $this->setProperty('encoding', $encoding); } /** - * A citation or reference to another creative work, such as another - * publication, web page, scholarly article, etc. + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. * - * @param CreativeWork|CreativeWork[]|string|string[] $citation + * @param string|string[] $encodingFormat * * @return static * - * @see http://schema.org/citation + * @see http://schema.org/encodingFormat */ - public function citation($citation) + public function encodingFormat($encodingFormat) { - return $this->setProperty('citation', $citation); + return $this->setProperty('encodingFormat', $encodingFormat); } /** - * Comments, typically from users. + * A media object that encodes this CreativeWork. * - * @param Comment|Comment[] $comment + * @param MediaObject|MediaObject[] $encodings * * @return static * - * @see http://schema.org/comment + * @see http://schema.org/encodings */ - public function comment($comment) + public function encodings($encodings) { - return $this->setProperty('comment', $comment); + return $this->setProperty('encodings', $encodings); } /** - * The number of comments this CreativeWork (e.g. Article, Question or - * Answer) has received. This is most applicable to works published in Web - * sites with commenting system; additional comments may exist elsewhere. + * A creative work that this work is an + * example/instance/realization/derivation of. * - * @param int|int[] $commentCount + * @param CreativeWork|CreativeWork[] $exampleOfWork * * @return static * - * @see http://schema.org/commentCount + * @see http://schema.org/exampleOfWork */ - public function commentCount($commentCount) + public function exampleOfWork($exampleOfWork) { - return $this->setProperty('commentCount', $commentCount); + return $this->setProperty('exampleOfWork', $exampleOfWork); } /** - * The location depicted or described in the content. For example, the - * location in a photograph or painting. + * Date the content expires and is no longer useful or available. For + * example a [[VideoObject]] or [[NewsArticle]] whose availability or + * relevance is time-limited, or a [[ClaimReview]] fact check whose + * publisher wants to indicate that it may no longer be relevant (or helpful + * to highlight) after some date. * - * @param Place|Place[] $contentLocation + * @param \DateTimeInterface|\DateTimeInterface[] $expires * * @return static * - * @see http://schema.org/contentLocation + * @see http://schema.org/expires */ - public function contentLocation($contentLocation) + public function expires($expires) { - return $this->setProperty('contentLocation', $contentLocation); + return $this->setProperty('expires', $expires); } /** - * Official rating of a piece of content—for example,'MPAA PG-13'. + * Features or modules provided by this application (and possibly required + * by other applications). * - * @param Rating|Rating[]|string|string[] $contentRating + * @param string|string[] $featureList * * @return static * - * @see http://schema.org/contentRating + * @see http://schema.org/featureList */ - public function contentRating($contentRating) + public function featureList($featureList) { - return $this->setProperty('contentRating', $contentRating); + return $this->setProperty('featureList', $featureList); } /** - * A secondary contributor to the CreativeWork or Event. + * Media type, typically MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of + * the content e.g. application/zip of a SoftwareApplication binary. In + * cases where a CreativeWork has several media type representations, + * 'encoding' can be used to indicate each MediaObject alongside particular + * fileFormat information. Unregistered or niche file formats can be + * indicated instead via the most appropriate URL, e.g. defining Web page or + * a Wikipedia entry. * - * @param Organization|Organization[]|Person|Person[] $contributor + * @param string|string[] $fileFormat * * @return static * - * @see http://schema.org/contributor + * @see http://schema.org/fileFormat */ - public function contributor($contributor) + public function fileFormat($fileFormat) { - return $this->setProperty('contributor', $contributor); + return $this->setProperty('fileFormat', $fileFormat); } /** - * The party holding the legal copyright to the CreativeWork. + * Size of the application / package (e.g. 18MB). In the absence of a unit + * (MB, KB etc.), KB will be assumed. * - * @param Organization|Organization[]|Person|Person[] $copyrightHolder + * @param string|string[] $fileSize * * @return static * - * @see http://schema.org/copyrightHolder + * @see http://schema.org/fileSize */ - public function copyrightHolder($copyrightHolder) + public function fileSize($fileSize) { - return $this->setProperty('copyrightHolder', $copyrightHolder); + return $this->setProperty('fileSize', $fileSize); } /** - * The year during which the claimed copyright for the CreativeWork was - * first asserted. + * A person or organization that supports (sponsors) something through some + * kind of financial contribution. * - * @param float|float[]|int|int[] $copyrightYear + * @param Organization|Organization[]|Person|Person[] $funder * * @return static * - * @see http://schema.org/copyrightYear + * @see http://schema.org/funder */ - public function copyrightYear($copyrightYear) + public function funder($funder) { - return $this->setProperty('copyrightYear', $copyrightYear); + return $this->setProperty('funder', $funder); } /** - * The creator/author of this CreativeWork. This is the same as the Author - * property for CreativeWork. + * An item is an object within the game world that can be collected by a + * player or, occasionally, a non-player character. * - * @param Organization|Organization[]|Person|Person[] $creator + * @param Thing|Thing[] $gameItem * * @return static * - * @see http://schema.org/creator + * @see http://schema.org/gameItem */ - public function creator($creator) + public function gameItem($gameItem) { - return $this->setProperty('creator', $creator); + return $this->setProperty('gameItem', $gameItem); } /** - * The date on which the CreativeWork was created or the item was added to a - * DataFeed. + * Real or fictional location of the game (or part of game). * - * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $gameLocation * * @return static * - * @see http://schema.org/dateCreated + * @see http://schema.org/gameLocation */ - public function dateCreated($dateCreated) + public function gameLocation($gameLocation) { - return $this->setProperty('dateCreated', $dateCreated); + return $this->setProperty('gameLocation', $gameLocation); } /** - * The date on which the CreativeWork was most recently modified or when the - * item's entry was modified within a DataFeed. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateModified - * - * @return static - * - * @see http://schema.org/dateModified - */ - public function dateModified($dateModified) - { - return $this->setProperty('dateModified', $dateModified); - } - - /** - * Date of first broadcast/publication. - * - * @param \DateTimeInterface|\DateTimeInterface[] $datePublished - * - * @return static - * - * @see http://schema.org/datePublished - */ - public function datePublished($datePublished) - { - return $this->setProperty('datePublished', $datePublished); - } - - /** - * A link to the page containing the comments of the CreativeWork. - * - * @param string|string[] $discussionUrl - * - * @return static - * - * @see http://schema.org/discussionUrl - */ - public function discussionUrl($discussionUrl) - { - return $this->setProperty('discussionUrl', $discussionUrl); - } - - /** - * Specifies the Person who edited the CreativeWork. - * - * @param Person|Person[] $editor - * - * @return static - * - * @see http://schema.org/editor - */ - public function editor($editor) - { - return $this->setProperty('editor', $editor); - } - - /** - * An alignment to an established educational framework. - * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment - * - * @return static - * - * @see http://schema.org/educationalAlignment - */ - public function educationalAlignment($educationalAlignment) - { - return $this->setProperty('educationalAlignment', $educationalAlignment); - } - - /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. - * - * @param string|string[] $educationalUse - * - * @return static - * - * @see http://schema.org/educationalUse - */ - public function educationalUse($educationalUse) - { - return $this->setProperty('educationalUse', $educationalUse); - } - - /** - * A media object that encodes this CreativeWork. This property is a synonym - * for associatedMedia. - * - * @param MediaObject|MediaObject[] $encoding - * - * @return static - * - * @see http://schema.org/encoding - */ - public function encoding($encoding) - { - return $this->setProperty('encoding', $encoding); - } - - /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside - * particular [[encodingFormat]] information. - * - * Unregistered or niche encoding and file formats can be indicated instead - * via the most appropriate URL, e.g. defining Web page or a - * Wikipedia/Wikidata entry. + * The electronic systems used to play video + * games. * - * @param string|string[] $encodingFormat + * @param Thing|Thing[]|string|string[] $gamePlatform * * @return static * - * @see http://schema.org/encodingFormat + * @see http://schema.org/gamePlatform */ - public function encodingFormat($encodingFormat) + public function gamePlatform($gamePlatform) { - return $this->setProperty('encodingFormat', $encodingFormat); + return $this->setProperty('gamePlatform', $gamePlatform); } /** - * A media object that encodes this CreativeWork. + * The server on which it is possible to play the game. * - * @param MediaObject|MediaObject[] $encodings + * @param GameServer|GameServer[] $gameServer * * @return static * - * @see http://schema.org/encodings + * @see http://schema.org/gameServer */ - public function encodings($encodings) + public function gameServer($gameServer) { - return $this->setProperty('encodings', $encodings); + return $this->setProperty('gameServer', $gameServer); } /** - * A creative work that this work is an - * example/instance/realization/derivation of. + * Links to tips, tactics, etc. * - * @param CreativeWork|CreativeWork[] $exampleOfWork + * @param CreativeWork|CreativeWork[] $gameTip * * @return static * - * @see http://schema.org/exampleOfWork + * @see http://schema.org/gameTip */ - public function exampleOfWork($exampleOfWork) + public function gameTip($gameTip) { - return $this->setProperty('exampleOfWork', $exampleOfWork); + return $this->setProperty('gameTip', $gameTip); } /** - * Date the content expires and is no longer useful or available. For - * example a [[VideoObject]] or [[NewsArticle]] whose availability or - * relevance is time-limited, or a [[ClaimReview]] fact check whose - * publisher wants to indicate that it may no longer be relevant (or helpful - * to highlight) after some date. + * Genre of the creative work, broadcast channel or group. * - * @param \DateTimeInterface|\DateTimeInterface[] $expires + * @param string|string[] $genre * * @return static * - * @see http://schema.org/expires + * @see http://schema.org/genre */ - public function expires($expires) + public function genre($genre) { - return $this->setProperty('expires', $expires); + return $this->setProperty('genre', $genre); } /** - * Media type, typically MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of - * the content e.g. application/zip of a SoftwareApplication binary. In - * cases where a CreativeWork has several media type representations, - * 'encoding' can be used to indicate each MediaObject alongside particular - * fileFormat information. Unregistered or niche file formats can be - * indicated instead via the most appropriate URL, e.g. defining Web page or - * a Wikipedia entry. + * Indicates an item or CreativeWork that is part of this item, or + * CreativeWork (in some sense). * - * @param string|string[] $fileFormat + * @param CreativeWork|CreativeWork[] $hasPart * * @return static * - * @see http://schema.org/fileFormat + * @see http://schema.org/hasPart */ - public function fileFormat($fileFormat) + public function hasPart($hasPart) { - return $this->setProperty('fileFormat', $fileFormat); + return $this->setProperty('hasPart', $hasPart); } /** - * A person or organization that supports (sponsors) something through some - * kind of financial contribution. + * Headline of the article. * - * @param Organization|Organization[]|Person|Person[] $funder + * @param string|string[] $headline * * @return static * - * @see http://schema.org/funder + * @see http://schema.org/headline */ - public function funder($funder) + public function headline($headline) { - return $this->setProperty('funder', $funder); + return $this->setProperty('headline', $headline); } /** - * Genre of the creative work, broadcast channel or group. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param string|string[] $genre + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/genre + * @see http://schema.org/identifier */ - public function genre($genre) + public function identifier($identifier) { - return $this->setProperty('genre', $genre); + return $this->setProperty('identifier', $identifier); } /** - * Indicates an item or CreativeWork that is part of this item, or - * CreativeWork (in some sense). + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param CreativeWork|CreativeWork[] $hasPart + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/hasPart + * @see http://schema.org/image */ - public function hasPart($hasPart) + public function image($image) { - return $this->setProperty('hasPart', $hasPart); + return $this->setProperty('image', $image); } /** - * Headline of the article. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param string|string[] $headline + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/headline + * @see http://schema.org/inLanguage */ - public function headline($headline) + public function inLanguage($inLanguage) { - return $this->setProperty('headline', $headline); + return $this->setProperty('inLanguage', $inLanguage); } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. + * URL at which the app may be installed, if different from the URL of the + * item. * - * @param Language|Language[]|string|string[] $inLanguage + * @param string|string[] $installUrl * * @return static * - * @see http://schema.org/inLanguage + * @see http://schema.org/installUrl */ - public function inLanguage($inLanguage) + public function installUrl($installUrl) { - return $this->setProperty('inLanguage', $inLanguage); + return $this->setProperty('installUrl', $installUrl); } /** @@ -1403,6 +1311,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1418,6 +1342,20 @@ public function material($material) return $this->setProperty('material', $material); } + /** + * Minimum memory requirements. + * + * @param string|string[] $memoryRequirements + * + * @return static + * + * @see http://schema.org/memoryRequirements + */ + public function memoryRequirements($memoryRequirements) + { + return $this->setProperty('memoryRequirements', $memoryRequirements); + } + /** * Indicates that the CreativeWork contains a reference to, but is not * necessarily about a concept. @@ -1433,6 +1371,48 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * Indicate how many people can play this game (minimum, maximum, or range). + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfPlayers + * + * @return static + * + * @see http://schema.org/numberOfPlayers + */ + public function numberOfPlayers($numberOfPlayers) + { + return $this->setProperty('numberOfPlayers', $numberOfPlayers); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1449,6 +1429,51 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). + * + * @param string|string[] $operatingSystem + * + * @return static + * + * @see http://schema.org/operatingSystem + */ + public function operatingSystem($operatingSystem) + { + return $this->setProperty('operatingSystem', $operatingSystem); + } + + /** + * Permission(s) required to run the app (for example, a mobile app may + * require full internet access or may run only on wifi). + * + * @param string|string[] $permissions + * + * @return static + * + * @see http://schema.org/permissions + */ + public function permissions($permissions) + { + return $this->setProperty('permissions', $permissions); + } + + /** + * Indicates whether this game is multi-player, co-op or single-player. The + * game can be marked as multi-player, co-op and single-player at the same + * time. + * + * @param GamePlayMode|GamePlayMode[] $playMode + * + * @return static + * + * @see http://schema.org/playMode + */ + public function playMode($playMode) + { + return $this->setProperty('playMode', $playMode); + } + /** * The position of an item in a series or sequence of items. * @@ -1463,6 +1488,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Processor architecture required to run the application (e.g. IA64). + * + * @param string|string[] $processorRequirements + * + * @return static + * + * @see http://schema.org/processorRequirements + */ + public function processorRequirements($processorRequirements) + { + return $this->setProperty('processorRequirements', $processorRequirements); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1546,6 +1600,21 @@ public function publishingPrinciples($publishingPrinciples) return $this->setProperty('publishingPrinciples', $publishingPrinciples); } + /** + * The task that a player-controlled character, or group of characters may + * complete in order to gain a reward. + * + * @param Thing|Thing[] $quest + * + * @return static + * + * @see http://schema.org/quest + */ + public function quest($quest) + { + return $this->setProperty('quest', $quest); + } + /** * The Event where the CreativeWork was recorded. The CreativeWork may * capture all or part of the event. @@ -1561,6 +1630,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * Description of what changed in this version. + * + * @param string|string[] $releaseNotes + * + * @return static + * + * @see http://schema.org/releaseNotes + */ + public function releaseNotes($releaseNotes) + { + return $this->setProperty('releaseNotes', $releaseNotes); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1576,6 +1659,23 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $requirements + * + * @return static + * + * @see http://schema.org/requirements + */ + public function requirements($requirements) + { + return $this->setProperty('requirements', $requirements); + } + /** * A review of the item. * @@ -1604,6 +1704,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1622,404 +1738,318 @@ public function schemaVersion($schemaVersion) } /** - * The Organization on whose behalf the creator was working. + * A link to a screenshot image of the app. * - * @param Organization|Organization[] $sourceOrganization + * @param ImageObject|ImageObject[]|string|string[] $screenshot * * @return static * - * @see http://schema.org/sourceOrganization + * @see http://schema.org/screenshot */ - public function sourceOrganization($sourceOrganization) + public function screenshot($screenshot) { - return $this->setProperty('sourceOrganization', $sourceOrganization); + return $this->setProperty('screenshot', $screenshot); } /** - * The "spatial" property can be used in cases when more specific properties - * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are - * not known to be appropriate. + * Additional content for a software application. * - * @param Place|Place[] $spatial + * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn * * @return static * - * @see http://schema.org/spatial + * @see http://schema.org/softwareAddOn */ - public function spatial($spatial) + public function softwareAddOn($softwareAddOn) { - return $this->setProperty('spatial', $spatial); + return $this->setProperty('softwareAddOn', $softwareAddOn); } /** - * The spatialCoverage of a CreativeWork indicates the place(s) which are - * the focus of the content. It is a subproperty of - * contentLocation intended primarily for more technical and detailed - * materials. For example with a Dataset, it indicates - * areas that the dataset describes: a dataset of New York weather - * would have spatialCoverage which was the place: the state of New York. + * Software application help. * - * @param Place|Place[] $spatialCoverage + * @param CreativeWork|CreativeWork[] $softwareHelp * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/softwareHelp */ - public function spatialCoverage($spatialCoverage) + public function softwareHelp($softwareHelp) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('softwareHelp', $softwareHelp); } /** - * 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. + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param string|string[] $softwareRequirements * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/softwareRequirements */ - public function sponsor($sponsor) + public function softwareRequirements($softwareRequirements) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('softwareRequirements', $softwareRequirements); } /** - * The "temporal" property can be used in cases where more specific - * properties - * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], - * [[datePublished]]) are not known to be appropriate. + * Version of the software instance. * - * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal + * @param string|string[] $softwareVersion * * @return static * - * @see http://schema.org/temporal + * @see http://schema.org/softwareVersion */ - public function temporal($temporal) + public function softwareVersion($softwareVersion) { - return $this->setProperty('temporal', $temporal); - } - - /** - * The temporalCoverage of a CreativeWork indicates the period that the - * content applies to, i.e. that it describes, either as a DateTime or as a - * textual string indicating a time period in [ISO 8601 time interval - * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In - * the case of a Dataset it will typically indicate the relevant time - * period in a precise notation (e.g. for a 2011 census dataset, the year - * 2011 would be written "2011/2012"). Other forms of content e.g. - * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their - * temporalCoverage in broader terms - textually or via well-known URL. - * Written works such as books may sometimes have precise temporal - * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 - * interval format format via "1939/1945". - * - * Open-ended date ranges can be written with ".." in place of the end date. - * For example, "2015-11/.." indicates a range beginning in November 2015 - * and with no specified final date. This is tentative and might be updated - * in future when ISO 8601 is officially updated. - * - * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage - * - * @return static - * - * @see http://schema.org/temporalCoverage - */ - public function temporalCoverage($temporalCoverage) - { - return $this->setProperty('temporalCoverage', $temporalCoverage); - } - - /** - * The textual content of this CreativeWork. - * - * @param string|string[] $text - * - * @return static - * - * @see http://schema.org/text - */ - public function text($text) - { - return $this->setProperty('text', $text); - } - - /** - * A thumbnail image relevant to the Thing. - * - * @param string|string[] $thumbnailUrl - * - * @return static - * - * @see http://schema.org/thumbnailUrl - */ - public function thumbnailUrl($thumbnailUrl) - { - return $this->setProperty('thumbnailUrl', $thumbnailUrl); - } - - /** - * Approximate or typical time it takes to work with or through this - * learning resource for the typical intended target audience, e.g. 'PT30M', - * 'PT1H25M'. - * - * @param Duration|Duration[] $timeRequired - * - * @return static - * - * @see http://schema.org/timeRequired - */ - public function timeRequired($timeRequired) - { - return $this->setProperty('timeRequired', $timeRequired); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $translator - * - * @return static - * - * @see http://schema.org/translator - */ - public function translator($translator) - { - return $this->setProperty('translator', $translator); + return $this->setProperty('softwareVersion', $softwareVersion); } /** - * The typical expected age range, e.g. '7-9', '11-'. + * The Organization on whose behalf the creator was working. * - * @param string|string[] $typicalAgeRange + * @param Organization|Organization[] $sourceOrganization * * @return static * - * @see http://schema.org/typicalAgeRange + * @see http://schema.org/sourceOrganization */ - public function typicalAgeRange($typicalAgeRange) + public function sourceOrganization($sourceOrganization) { - return $this->setProperty('typicalAgeRange', $typicalAgeRange); + return $this->setProperty('sourceOrganization', $sourceOrganization); } /** - * The version of the CreativeWork embodied by a specified resource. + * The "spatial" property can be used in cases when more specific properties + * (e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are + * not known to be appropriate. * - * @param float|float[]|int|int[]|string|string[] $version + * @param Place|Place[] $spatial * * @return static * - * @see http://schema.org/version + * @see http://schema.org/spatial */ - public function version($version) + public function spatial($spatial) { - return $this->setProperty('version', $version); + return $this->setProperty('spatial', $spatial); } /** - * An embedded video object. + * The spatialCoverage of a CreativeWork indicates the place(s) which are + * the focus of the content. It is a subproperty of + * contentLocation intended primarily for more technical and detailed + * materials. For example with a Dataset, it indicates + * areas that the dataset describes: a dataset of New York weather + * would have spatialCoverage which was the place: the state of New York. * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video + * @param Place|Place[] $spatialCoverage * * @return static * - * @see http://schema.org/video + * @see http://schema.org/spatialCoverage */ - public function video($video) + public function spatialCoverage($spatialCoverage) { - return $this->setProperty('video', $video); + return $this->setProperty('spatialCoverage', $spatialCoverage); } /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. + * 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. * - * @param CreativeWork|CreativeWork[] $workExample + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/workExample + * @see http://schema.org/sponsor */ - public function workExample($workExample) + public function sponsor($sponsor) { - return $this->setProperty('workExample', $workExample); + return $this->setProperty('sponsor', $sponsor); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * Storage requirements (free space required). * - * @param string|string[] $additionalType + * @param string|string[] $storageRequirements * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/storageRequirements */ - public function additionalType($additionalType) + public function storageRequirements($storageRequirements) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('storageRequirements', $storageRequirements); } /** - * An alias for the item. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/subjectOf */ - public function alternateName($alternateName) + public function subjectOf($subjectOf) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A description of the item. + * Supporting data for a SoftwareApplication. * - * @param string|string[] $description + * @param DataFeed|DataFeed[] $supportingData * * @return static * - * @see http://schema.org/description + * @see http://schema.org/supportingData */ - public function description($description) + public function supportingData($supportingData) { - return $this->setProperty('description', $description); + return $this->setProperty('supportingData', $supportingData); } /** - * 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. + * The "temporal" property can be used in cases where more specific + * properties + * (e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], + * [[datePublished]]) are not known to be appropriate. * - * @param string|string[] $disambiguatingDescription + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporal * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/temporal */ - public function disambiguatingDescription($disambiguatingDescription) + public function temporal($temporal) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('temporal', $temporal); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The temporalCoverage of a CreativeWork indicates the period that the + * content applies to, i.e. that it describes, either as a DateTime or as a + * textual string indicating a time period in [ISO 8601 time interval + * format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In + * the case of a Dataset it will typically indicate the relevant time + * period in a precise notation (e.g. for a 2011 census dataset, the year + * 2011 would be written "2011/2012"). Other forms of content e.g. + * ScholarlyArticle, Book, TVSeries or TVEpisode may indicate their + * temporalCoverage in broader terms - textually or via well-known URL. + * Written works such as books may sometimes have precise temporal + * coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 + * interval format format via "1939/1945". + * + * Open-ended date ranges can be written with ".." in place of the end date. + * For example, "2015-11/.." indicates a range beginning in November 2015 + * and with no specified final date. This is tentative and might be updated + * in future when ISO 8601 is officially updated. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param \DateTimeInterface|\DateTimeInterface[]|string|string[] $temporalCoverage * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/temporalCoverage */ - public function identifier($identifier) + public function temporalCoverage($temporalCoverage) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('temporalCoverage', $temporalCoverage); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The textual content of this CreativeWork. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $text * * @return static * - * @see http://schema.org/image + * @see http://schema.org/text */ - public function image($image) + public function text($text) { - return $this->setProperty('image', $image); + return $this->setProperty('text', $text); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * A thumbnail image relevant to the Thing. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param string|string[] $thumbnailUrl * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/thumbnailUrl */ - public function mainEntityOfPage($mainEntityOfPage) + public function thumbnailUrl($thumbnailUrl) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('thumbnailUrl', $thumbnailUrl); } /** - * The name of the item. + * Approximate or typical time it takes to work with or through this + * learning resource for the typical intended target audience, e.g. 'PT30M', + * 'PT1H25M'. * - * @param string|string[] $name + * @param Duration|Duration[] $timeRequired * * @return static * - * @see http://schema.org/name + * @see http://schema.org/timeRequired */ - public function name($name) + public function timeRequired($timeRequired) { - return $this->setProperty('name', $name); + return $this->setProperty('timeRequired', $timeRequired); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The trailer of a movie or tv/radio series, season, episode, etc. * - * @param Action|Action[] $potentialAction + * @param VideoObject|VideoObject[] $trailer * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/trailer */ - public function potentialAction($potentialAction) + public function trailer($trailer) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('trailer', $trailer); } /** - * 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. + * 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. * - * @param string|string[] $sameAs + * @param Organization|Organization[]|Person|Person[] $translator * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/translator */ - public function sameAs($sameAs) + public function translator($translator) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('translator', $translator); } /** - * A CreativeWork or Event about this Thing. + * The typical expected age range, e.g. '7-9', '11-'. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $typicalAgeRange * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/typicalAgeRange */ - public function subjectOf($subjectOf) + public function typicalAgeRange($typicalAgeRange) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('typicalAgeRange', $typicalAgeRange); } /** @@ -2037,76 +2067,46 @@ public function url($url) } /** - * A piece of data that represents a particular aspect of a fictional - * character (skill, power, character points, advantage, disadvantage). - * - * @param Thing|Thing[] $characterAttribute - * - * @return static - * - * @see http://schema.org/characterAttribute - */ - public function characterAttribute($characterAttribute) - { - return $this->setProperty('characterAttribute', $characterAttribute); - } - - /** - * An item is an object within the game world that can be collected by a - * player or, occasionally, a non-player character. - * - * @param Thing|Thing[] $gameItem - * - * @return static - * - * @see http://schema.org/gameItem - */ - public function gameItem($gameItem) - { - return $this->setProperty('gameItem', $gameItem); - } - - /** - * Real or fictional location of the game (or part of game). + * The version of the CreativeWork embodied by a specified resource. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $gameLocation + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/gameLocation + * @see http://schema.org/version */ - public function gameLocation($gameLocation) + public function version($version) { - return $this->setProperty('gameLocation', $gameLocation); + return $this->setProperty('version', $version); } /** - * Indicate how many people can play this game (minimum, maximum, or range). + * An embedded video object. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfPlayers + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/numberOfPlayers + * @see http://schema.org/video */ - public function numberOfPlayers($numberOfPlayers) + public function video($video) { - return $this->setProperty('numberOfPlayers', $numberOfPlayers); + return $this->setProperty('video', $video); } /** - * The task that a player-controlled character, or group of characters may - * complete in order to gain a reward. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param Thing|Thing[] $quest + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/quest + * @see http://schema.org/workExample */ - public function quest($quest) + public function workExample($workExample) { - return $this->setProperty('quest', $quest); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/VideoGameClip.php b/src/VideoGameClip.php index a6bc37c44..36a5e89e7 100644 --- a/src/VideoGameClip.php +++ b/src/VideoGameClip.php @@ -14,138 +14,6 @@ */ class VideoGameClip extends BaseType implements ClipContract, CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * Position of the clip within an ordered group of clips. - * - * @param int|int[]|string|string[] $clipNumber - * - * @return static - * - * @see http://schema.org/clipNumber - */ - public function clipNumber($clipNumber) - { - return $this->setProperty('clipNumber', $clipNumber); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * The episode to which this clip belongs. - * - * @param Episode|Episode[] $partOfEpisode - * - * @return static - * - * @see http://schema.org/partOfEpisode - */ - public function partOfEpisode($partOfEpisode) - { - return $this->setProperty('partOfEpisode', $partOfEpisode); - } - - /** - * The season to which this episode belongs. - * - * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason - * - * @return static - * - * @see http://schema.org/partOfSeason - */ - public function partOfSeason($partOfSeason) - { - return $this->setProperty('partOfSeason', $partOfSeason); - } - - /** - * The series to which this episode or season belongs. - * - * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries - * - * @return static - * - * @see http://schema.org/partOfSeries - */ - public function partOfSeries($partOfSeries) - { - return $this->setProperty('partOfSeries', $partOfSeries); - } - /** * The subject matter of the content. * @@ -290,6 +158,56 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors + * + * @return static + * + * @see http://schema.org/actors + */ + public function actors($actors) + { + return $this->setProperty('actors', $actors); + } + + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -305,6 +223,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -435,6 +367,20 @@ public function citation($citation) return $this->setProperty('citation', $citation); } + /** + * Position of the clip within an ordered group of clips. + * + * @param int|int[]|string|string[] $clipNumber + * + * @return static + * + * @see http://schema.org/clipNumber + */ + public function clipNumber($clipNumber) + { + return $this->setProperty('clipNumber', $clipNumber); + } + /** * Comments, typically from users. * @@ -597,60 +543,122 @@ public function datePublished($datePublished) } /** - * A link to the page containing the comments of the CreativeWork. + * A description of the item. * - * @param string|string[] $discussionUrl + * @param string|string[] $description * * @return static * - * @see http://schema.org/discussionUrl + * @see http://schema.org/description */ - public function discussionUrl($discussionUrl) + public function description($description) { - return $this->setProperty('discussionUrl', $discussionUrl); + return $this->setProperty('description', $description); } /** - * Specifies the Person who edited the CreativeWork. + * 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. * - * @param Person|Person[] $editor + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/editor + * @see http://schema.org/director */ - public function editor($editor) + public function director($director) { - return $this->setProperty('editor', $editor); + return $this->setProperty('director', $director); } /** - * An alignment to an established educational framework. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/educationalAlignment + * @see http://schema.org/directors */ - public function educationalAlignment($educationalAlignment) + public function directors($directors) { - return $this->setProperty('educationalAlignment', $educationalAlignment); + return $this->setProperty('directors', $directors); } /** - * The purpose of a work in the context of education; for example, - * 'assignment', 'group work'. + * 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. * - * @param string|string[] $educationalUse + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/disambiguatingDescription */ - public function educationalUse($educationalUse) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + + /** + * A link to the page containing the comments of the CreativeWork. + * + * @param string|string[] $discussionUrl + * + * @return static + * + * @see http://schema.org/discussionUrl + */ + public function discussionUrl($discussionUrl) + { + return $this->setProperty('discussionUrl', $discussionUrl); + } + + /** + * Specifies the Person who edited the CreativeWork. + * + * @param Person|Person[] $editor + * + * @return static + * + * @see http://schema.org/editor + */ + public function editor($editor) + { + return $this->setProperty('editor', $editor); + } + + /** + * An alignment to an established educational framework. + * + * @param AlignmentObject|AlignmentObject[] $educationalAlignment + * + * @return static + * + * @see http://schema.org/educationalAlignment + */ + public function educationalAlignment($educationalAlignment) + { + return $this->setProperty('educationalAlignment', $educationalAlignment); + } + + /** + * The purpose of a work in the context of education; for example, + * 'assignment', 'group work'. + * + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); } /** @@ -821,6 +829,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1018,6 +1059,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1048,6 +1105,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1064,6 +1149,48 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * The episode to which this clip belongs. + * + * @param Episode|Episode[] $partOfEpisode + * + * @return static + * + * @see http://schema.org/partOfEpisode + */ + public function partOfEpisode($partOfEpisode) + { + return $this->setProperty('partOfEpisode', $partOfEpisode); + } + + /** + * The season to which this episode belongs. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $partOfSeason + * + * @return static + * + * @see http://schema.org/partOfSeason + */ + public function partOfSeason($partOfSeason) + { + return $this->setProperty('partOfSeason', $partOfSeason); + } + + /** + * The series to which this episode or season belongs. + * + * @param CreativeWorkSeries|CreativeWorkSeries[] $partOfSeries + * + * @return static + * + * @see http://schema.org/partOfSeries + */ + public function partOfSeries($partOfSeries) + { + return $this->setProperty('partOfSeries', $partOfSeries); + } + /** * The position of an item in a series or sequence of items. * @@ -1078,6 +1205,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1219,6 +1361,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1301,6 +1459,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1422,6 +1594,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1465,190 +1651,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/VideoGameSeries.php b/src/VideoGameSeries.php index 1194dd50e..2a1f11cbe 100644 --- a/src/VideoGameSeries.php +++ b/src/VideoGameSeries.php @@ -17,845 +17,646 @@ class VideoGameSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract { /** - * 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. + * The subject matter of the content. * - * @param Person|Person[] $actor + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/actor + * @see http://schema.org/about */ - public function actor($actor) + public function about($about) { - return $this->setProperty('actor', $actor); + return $this->setProperty('about', $about); } /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. * - * @param Person|Person[] $actors + * @param string|string[] $accessMode * * @return static * - * @see http://schema.org/actors + * @see http://schema.org/accessMode */ - public function actors($actors) + public function accessMode($accessMode) { - return $this->setProperty('actors', $actors); + return $this->setProperty('accessMode', $accessMode); } /** - * A piece of data that represents a particular aspect of a fictional - * character (skill, power, character points, advantage, disadvantage). + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. * - * @param Thing|Thing[] $characterAttribute + * @param ItemList|ItemList[] $accessModeSufficient * * @return static * - * @see http://schema.org/characterAttribute + * @see http://schema.org/accessModeSufficient */ - public function characterAttribute($characterAttribute) + public function accessModeSufficient($accessModeSufficient) { - return $this->setProperty('characterAttribute', $characterAttribute); + return $this->setProperty('accessModeSufficient', $accessModeSufficient); } /** - * Cheat codes to the game. + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param CreativeWork|CreativeWork[] $cheatCode + * @param string|string[] $accessibilityAPI * * @return static * - * @see http://schema.org/cheatCode + * @see http://schema.org/accessibilityAPI */ - public function cheatCode($cheatCode) + public function accessibilityAPI($accessibilityAPI) { - return $this->setProperty('cheatCode', $cheatCode); + return $this->setProperty('accessibilityAPI', $accessibilityAPI); } /** - * A season that is part of the media series. + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param CreativeWorkSeason|CreativeWorkSeason[] $containsSeason + * @param string|string[] $accessibilityControl * * @return static * - * @see http://schema.org/containsSeason + * @see http://schema.org/accessibilityControl */ - public function containsSeason($containsSeason) + public function accessibilityControl($accessibilityControl) { - return $this->setProperty('containsSeason', $containsSeason); + return $this->setProperty('accessibilityControl', $accessibilityControl); } /** - * 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. + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Person|Person[] $director + * @param string|string[] $accessibilityFeature * * @return static * - * @see http://schema.org/director + * @see http://schema.org/accessibilityFeature */ - public function director($director) + public function accessibilityFeature($accessibilityFeature) { - return $this->setProperty('director', $director); + return $this->setProperty('accessibilityFeature', $accessibilityFeature); } /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Person|Person[] $directors + * @param string|string[] $accessibilityHazard * * @return static * - * @see http://schema.org/directors + * @see http://schema.org/accessibilityHazard */ - public function directors($directors) + public function accessibilityHazard($accessibilityHazard) { - return $this->setProperty('directors', $directors); + return $this->setProperty('accessibilityHazard', $accessibilityHazard); } /** - * An episode of a tv, radio or game media within a series or season. + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." * - * @param Episode|Episode[] $episode + * @param string|string[] $accessibilitySummary * * @return static * - * @see http://schema.org/episode + * @see http://schema.org/accessibilitySummary */ - public function episode($episode) + public function accessibilitySummary($accessibilitySummary) { - return $this->setProperty('episode', $episode); + return $this->setProperty('accessibilitySummary', $accessibilitySummary); } /** - * An episode of a TV/radio series or season. + * Specifies the Person that is legally accountable for the CreativeWork. * - * @param Episode|Episode[] $episodes + * @param Person|Person[] $accountablePerson * * @return static * - * @see http://schema.org/episodes + * @see http://schema.org/accountablePerson */ - public function episodes($episodes) + public function accountablePerson($accountablePerson) { - return $this->setProperty('episodes', $episodes); + return $this->setProperty('accountablePerson', $accountablePerson); } /** - * An item is an object within the game world that can be collected by a - * player or, occasionally, a non-player character. + * 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. * - * @param Thing|Thing[] $gameItem + * @param Person|Person[] $actor * * @return static * - * @see http://schema.org/gameItem + * @see http://schema.org/actor */ - public function gameItem($gameItem) + public function actor($actor) { - return $this->setProperty('gameItem', $gameItem); + return $this->setProperty('actor', $actor); } /** - * Real or fictional location of the game (or part of game). + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $gameLocation + * @param Person|Person[] $actors * * @return static * - * @see http://schema.org/gameLocation + * @see http://schema.org/actors */ - public function gameLocation($gameLocation) + public function actors($actors) { - return $this->setProperty('gameLocation', $gameLocation); + return $this->setProperty('actors', $actors); } /** - * The electronic systems used to play video - * games. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Thing|Thing[]|string|string[] $gamePlatform + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/gamePlatform + * @see http://schema.org/additionalType */ - public function gamePlatform($gamePlatform) + public function additionalType($additionalType) { - return $this->setProperty('gamePlatform', $gamePlatform); + return $this->setProperty('additionalType', $additionalType); } /** - * The composer of the soundtrack. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/musicBy + * @see http://schema.org/aggregateRating */ - public function musicBy($musicBy) + public function aggregateRating($aggregateRating) { - return $this->setProperty('musicBy', $musicBy); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The number of episodes in this season or series. + * An alias for the item. * - * @param int|int[] $numberOfEpisodes + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/numberOfEpisodes + * @see http://schema.org/alternateName */ - public function numberOfEpisodes($numberOfEpisodes) + public function alternateName($alternateName) { - return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + return $this->setProperty('alternateName', $alternateName); } /** - * Indicate how many people can play this game (minimum, maximum, or range). + * A secondary title of the CreativeWork. * - * @param QuantitativeValue|QuantitativeValue[] $numberOfPlayers + * @param string|string[] $alternativeHeadline * * @return static * - * @see http://schema.org/numberOfPlayers + * @see http://schema.org/alternativeHeadline */ - public function numberOfPlayers($numberOfPlayers) + public function alternativeHeadline($alternativeHeadline) { - return $this->setProperty('numberOfPlayers', $numberOfPlayers); + return $this->setProperty('alternativeHeadline', $alternativeHeadline); } /** - * The number of seasons in this series. + * A media object that encodes this CreativeWork. This property is a synonym + * for encoding. * - * @param int|int[] $numberOfSeasons + * @param MediaObject|MediaObject[] $associatedMedia * * @return static * - * @see http://schema.org/numberOfSeasons + * @see http://schema.org/associatedMedia */ - public function numberOfSeasons($numberOfSeasons) + public function associatedMedia($associatedMedia) { - return $this->setProperty('numberOfSeasons', $numberOfSeasons); + return $this->setProperty('associatedMedia', $associatedMedia); } /** - * Indicates whether this game is multi-player, co-op or single-player. The - * game can be marked as multi-player, co-op and single-player at the same - * time. + * An intended audience, i.e. a group for whom something was created. * - * @param GamePlayMode|GamePlayMode[] $playMode + * @param Audience|Audience[] $audience * * @return static * - * @see http://schema.org/playMode + * @see http://schema.org/audience */ - public function playMode($playMode) + public function audience($audience) { - return $this->setProperty('playMode', $playMode); + return $this->setProperty('audience', $audience); } /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. + * An embedded audio object. * - * @param Organization|Organization[] $productionCompany + * @param AudioObject|AudioObject[]|Clip|Clip[] $audio * * @return static * - * @see http://schema.org/productionCompany + * @see http://schema.org/audio */ - public function productionCompany($productionCompany) + public function audio($audio) { - return $this->setProperty('productionCompany', $productionCompany); + return $this->setProperty('audio', $audio); } /** - * The task that a player-controlled character, or group of characters may - * complete in order to gain a reward. + * The author of this content or rating. Please note that author is special + * in that HTML 5 provides a special mechanism for indicating authorship via + * the rel tag. That is equivalent to this and may be used interchangeably. * - * @param Thing|Thing[] $quest + * @param Organization|Organization[]|Person|Person[] $author * * @return static * - * @see http://schema.org/quest + * @see http://schema.org/author */ - public function quest($quest) + public function author($author) { - return $this->setProperty('quest', $quest); + return $this->setProperty('author', $author); } /** - * A season in a media series. + * An award won by or for this item. * - * @param CreativeWorkSeason|CreativeWorkSeason[] $season + * @param string|string[] $award * * @return static * - * @see http://schema.org/season + * @see http://schema.org/award */ - public function season($season) + public function award($award) { - return $this->setProperty('season', $season); + return $this->setProperty('award', $award); } /** - * A season in a media series. + * Awards won by or for this item. * - * @param CreativeWorkSeason|CreativeWorkSeason[] $seasons + * @param string|string[] $awards * * @return static * - * @see http://schema.org/seasons + * @see http://schema.org/awards */ - public function seasons($seasons) + public function awards($awards) { - return $this->setProperty('seasons', $seasons); + return $this->setProperty('awards', $awards); } /** - * The trailer of a movie or tv/radio series, season, episode, etc. + * Fictional person connected with a creative work. * - * @param VideoObject|VideoObject[] $trailer + * @param Person|Person[] $character * * @return static * - * @see http://schema.org/trailer + * @see http://schema.org/character */ - public function trailer($trailer) + public function character($character) { - return $this->setProperty('trailer', $trailer); + return $this->setProperty('character', $character); } /** - * The end date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). + * A piece of data that represents a particular aspect of a fictional + * character (skill, power, character points, advantage, disadvantage). * - * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * @param Thing|Thing[] $characterAttribute * * @return static * - * @see http://schema.org/endDate + * @see http://schema.org/characterAttribute */ - public function endDate($endDate) + public function characterAttribute($characterAttribute) { - return $this->setProperty('endDate', $endDate); + return $this->setProperty('characterAttribute', $characterAttribute); } /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * Cheat codes to the game. * - * @param string|string[] $issn + * @param CreativeWork|CreativeWork[] $cheatCode * * @return static * - * @see http://schema.org/issn + * @see http://schema.org/cheatCode */ - public function issn($issn) + public function cheatCode($cheatCode) { - return $this->setProperty('issn', $issn); + return $this->setProperty('cheatCode', $cheatCode); } /** - * The start date and time of the item (in [ISO 8601 date - * format](http://en.wikipedia.org/wiki/ISO_8601)). + * A citation or reference to another creative work, such as another + * publication, web page, scholarly article, etc. * - * @param \DateTimeInterface|\DateTimeInterface[] $startDate + * @param CreativeWork|CreativeWork[]|string|string[] $citation * * @return static * - * @see http://schema.org/startDate + * @see http://schema.org/citation */ - public function startDate($startDate) + public function citation($citation) { - return $this->setProperty('startDate', $startDate); + return $this->setProperty('citation', $citation); } /** - * The subject matter of the content. + * Comments, typically from users. * - * @param Thing|Thing[] $about + * @param Comment|Comment[] $comment * * @return static * - * @see http://schema.org/about + * @see http://schema.org/comment */ - public function about($about) + public function comment($comment) { - return $this->setProperty('about', $about); + return $this->setProperty('comment', $comment); } /** - * The human sensory perceptual system or cognitive faculty through which a - * person may process or perceive information. Expected values include: - * auditory, tactile, textual, visual, colorDependent, chartOnVisual, - * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * The number of comments this CreativeWork (e.g. Article, Question or + * Answer) has received. This is most applicable to works published in Web + * sites with commenting system; additional comments may exist elsewhere. * - * @param string|string[] $accessMode + * @param int|int[] $commentCount * * @return static * - * @see http://schema.org/accessMode + * @see http://schema.org/commentCount */ - public function accessMode($accessMode) + public function commentCount($commentCount) { - return $this->setProperty('accessMode', $accessMode); + return $this->setProperty('commentCount', $commentCount); } /** - * A list of single or combined accessModes that are sufficient to - * understand all the intellectual content of a resource. Expected values - * include: auditory, tactile, textual, visual. + * A season that is part of the media series. * - * @param ItemList|ItemList[] $accessModeSufficient + * @param CreativeWorkSeason|CreativeWorkSeason[] $containsSeason * * @return static * - * @see http://schema.org/accessModeSufficient + * @see http://schema.org/containsSeason */ - public function accessModeSufficient($accessModeSufficient) + public function containsSeason($containsSeason) { - return $this->setProperty('accessModeSufficient', $accessModeSufficient); + return $this->setProperty('containsSeason', $containsSeason); } /** - * Indicates that the resource is compatible with the referenced - * accessibility API ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * The location depicted or described in the content. For example, the + * location in a photograph or painting. * - * @param string|string[] $accessibilityAPI + * @param Place|Place[] $contentLocation * * @return static * - * @see http://schema.org/accessibilityAPI + * @see http://schema.org/contentLocation */ - public function accessibilityAPI($accessibilityAPI) + public function contentLocation($contentLocation) { - return $this->setProperty('accessibilityAPI', $accessibilityAPI); + return $this->setProperty('contentLocation', $contentLocation); } /** - * Identifies input methods that are sufficient to fully control the - * described resource ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * Official rating of a piece of content—for example,'MPAA PG-13'. * - * @param string|string[] $accessibilityControl + * @param Rating|Rating[]|string|string[] $contentRating * * @return static * - * @see http://schema.org/accessibilityControl + * @see http://schema.org/contentRating */ - public function accessibilityControl($accessibilityControl) + public function contentRating($contentRating) { - return $this->setProperty('accessibilityControl', $accessibilityControl); + return $this->setProperty('contentRating', $contentRating); } /** - * Content features of the resource, such as accessible media, alternatives - * and supported enhancements for accessibility ([WebSchemas wiki lists - * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * A secondary contributor to the CreativeWork or Event. * - * @param string|string[] $accessibilityFeature + * @param Organization|Organization[]|Person|Person[] $contributor * * @return static * - * @see http://schema.org/accessibilityFeature + * @see http://schema.org/contributor */ - public function accessibilityFeature($accessibilityFeature) + public function contributor($contributor) { - return $this->setProperty('accessibilityFeature', $accessibilityFeature); + return $this->setProperty('contributor', $contributor); } /** - * A characteristic of the described resource that is physiologically - * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas - * wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * The party holding the legal copyright to the CreativeWork. * - * @param string|string[] $accessibilityHazard + * @param Organization|Organization[]|Person|Person[] $copyrightHolder * * @return static * - * @see http://schema.org/accessibilityHazard + * @see http://schema.org/copyrightHolder */ - public function accessibilityHazard($accessibilityHazard) + public function copyrightHolder($copyrightHolder) { - return $this->setProperty('accessibilityHazard', $accessibilityHazard); + return $this->setProperty('copyrightHolder', $copyrightHolder); } /** - * A human-readable summary of specific accessibility features or - * deficiencies, consistent with the other accessibility metadata but - * expressing subtleties such as "short descriptions are present but long - * descriptions will be needed for non-visual users" or "short descriptions - * are present and no long descriptions are needed." + * The year during which the claimed copyright for the CreativeWork was + * first asserted. * - * @param string|string[] $accessibilitySummary + * @param float|float[]|int|int[] $copyrightYear * * @return static * - * @see http://schema.org/accessibilitySummary + * @see http://schema.org/copyrightYear */ - public function accessibilitySummary($accessibilitySummary) + public function copyrightYear($copyrightYear) { - return $this->setProperty('accessibilitySummary', $accessibilitySummary); + return $this->setProperty('copyrightYear', $copyrightYear); } /** - * Specifies the Person that is legally accountable for the CreativeWork. + * The creator/author of this CreativeWork. This is the same as the Author + * property for CreativeWork. * - * @param Person|Person[] $accountablePerson + * @param Organization|Organization[]|Person|Person[] $creator * * @return static * - * @see http://schema.org/accountablePerson + * @see http://schema.org/creator */ - public function accountablePerson($accountablePerson) + public function creator($creator) { - return $this->setProperty('accountablePerson', $accountablePerson); + return $this->setProperty('creator', $creator); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * The date on which the CreativeWork was created or the item was added to a + * DataFeed. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/dateCreated */ - public function aggregateRating($aggregateRating) + public function dateCreated($dateCreated) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('dateCreated', $dateCreated); } /** - * A secondary title of the CreativeWork. + * The date on which the CreativeWork was most recently modified or when the + * item's entry was modified within a DataFeed. * - * @param string|string[] $alternativeHeadline + * @param \DateTimeInterface|\DateTimeInterface[] $dateModified * * @return static * - * @see http://schema.org/alternativeHeadline + * @see http://schema.org/dateModified */ - public function alternativeHeadline($alternativeHeadline) + public function dateModified($dateModified) { - return $this->setProperty('alternativeHeadline', $alternativeHeadline); + return $this->setProperty('dateModified', $dateModified); } /** - * A media object that encodes this CreativeWork. This property is a synonym - * for encoding. + * Date of first broadcast/publication. * - * @param MediaObject|MediaObject[] $associatedMedia + * @param \DateTimeInterface|\DateTimeInterface[] $datePublished * * @return static * - * @see http://schema.org/associatedMedia + * @see http://schema.org/datePublished */ - public function associatedMedia($associatedMedia) + public function datePublished($datePublished) { - return $this->setProperty('associatedMedia', $associatedMedia); + return $this->setProperty('datePublished', $datePublished); } /** - * An intended audience, i.e. a group for whom something was created. + * A description of the item. * - * @param Audience|Audience[] $audience + * @param string|string[] $description * * @return static * - * @see http://schema.org/audience + * @see http://schema.org/description */ - public function audience($audience) + public function description($description) { - return $this->setProperty('audience', $audience); + return $this->setProperty('description', $description); } /** - * An embedded audio object. + * 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. * - * @param AudioObject|AudioObject[]|Clip|Clip[] $audio + * @param Person|Person[] $director * * @return static * - * @see http://schema.org/audio + * @see http://schema.org/director */ - public function audio($audio) + public function director($director) { - return $this->setProperty('audio', $audio); + return $this->setProperty('director', $director); } /** - * The author of this content or rating. Please note that author is special - * in that HTML 5 provides a special mechanism for indicating authorship via - * the rel tag. That is equivalent to this and may be used interchangeably. + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. * - * @param Organization|Organization[]|Person|Person[] $author + * @param Person|Person[] $directors * * @return static * - * @see http://schema.org/author + * @see http://schema.org/directors */ - public function author($author) + public function directors($directors) { - return $this->setProperty('author', $author); + return $this->setProperty('directors', $directors); } /** - * An award won by or for this item. + * 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. * - * @param string|string[] $award + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/award + * @see http://schema.org/disambiguatingDescription */ - public function award($award) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('award', $award); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * Awards won by or for this item. + * A link to the page containing the comments of the CreativeWork. * - * @param string|string[] $awards + * @param string|string[] $discussionUrl * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/discussionUrl */ - public function awards($awards) + public function discussionUrl($discussionUrl) { - return $this->setProperty('awards', $awards); + return $this->setProperty('discussionUrl', $discussionUrl); } /** - * Fictional person connected with a creative work. + * Specifies the Person who edited the CreativeWork. * - * @param Person|Person[] $character + * @param Person|Person[] $editor * * @return static * - * @see http://schema.org/character - */ - public function character($character) - { - return $this->setProperty('character', $character); - } - - /** - * A citation or reference to another creative work, such as another - * publication, web page, scholarly article, etc. - * - * @param CreativeWork|CreativeWork[]|string|string[] $citation - * - * @return static - * - * @see http://schema.org/citation - */ - public function citation($citation) - { - return $this->setProperty('citation', $citation); - } - - /** - * Comments, typically from users. - * - * @param Comment|Comment[] $comment - * - * @return static - * - * @see http://schema.org/comment - */ - public function comment($comment) - { - return $this->setProperty('comment', $comment); - } - - /** - * The number of comments this CreativeWork (e.g. Article, Question or - * Answer) has received. This is most applicable to works published in Web - * sites with commenting system; additional comments may exist elsewhere. - * - * @param int|int[] $commentCount - * - * @return static - * - * @see http://schema.org/commentCount - */ - public function commentCount($commentCount) - { - return $this->setProperty('commentCount', $commentCount); - } - - /** - * The location depicted or described in the content. For example, the - * location in a photograph or painting. - * - * @param Place|Place[] $contentLocation - * - * @return static - * - * @see http://schema.org/contentLocation - */ - public function contentLocation($contentLocation) - { - return $this->setProperty('contentLocation', $contentLocation); - } - - /** - * Official rating of a piece of content—for example,'MPAA PG-13'. - * - * @param Rating|Rating[]|string|string[] $contentRating - * - * @return static - * - * @see http://schema.org/contentRating - */ - public function contentRating($contentRating) - { - return $this->setProperty('contentRating', $contentRating); - } - - /** - * A secondary contributor to the CreativeWork or Event. - * - * @param Organization|Organization[]|Person|Person[] $contributor - * - * @return static - * - * @see http://schema.org/contributor - */ - public function contributor($contributor) - { - return $this->setProperty('contributor', $contributor); - } - - /** - * The party holding the legal copyright to the CreativeWork. - * - * @param Organization|Organization[]|Person|Person[] $copyrightHolder - * - * @return static - * - * @see http://schema.org/copyrightHolder - */ - public function copyrightHolder($copyrightHolder) - { - return $this->setProperty('copyrightHolder', $copyrightHolder); - } - - /** - * The year during which the claimed copyright for the CreativeWork was - * first asserted. - * - * @param float|float[]|int|int[] $copyrightYear - * - * @return static - * - * @see http://schema.org/copyrightYear - */ - public function copyrightYear($copyrightYear) - { - return $this->setProperty('copyrightYear', $copyrightYear); - } - - /** - * The creator/author of this CreativeWork. This is the same as the Author - * property for CreativeWork. - * - * @param Organization|Organization[]|Person|Person[] $creator - * - * @return static - * - * @see http://schema.org/creator - */ - public function creator($creator) - { - return $this->setProperty('creator', $creator); - } - - /** - * The date on which the CreativeWork was created or the item was added to a - * DataFeed. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateCreated - * - * @return static - * - * @see http://schema.org/dateCreated - */ - public function dateCreated($dateCreated) - { - return $this->setProperty('dateCreated', $dateCreated); - } - - /** - * The date on which the CreativeWork was most recently modified or when the - * item's entry was modified within a DataFeed. - * - * @param \DateTimeInterface|\DateTimeInterface[] $dateModified - * - * @return static - * - * @see http://schema.org/dateModified - */ - public function dateModified($dateModified) - { - return $this->setProperty('dateModified', $dateModified); - } - - /** - * Date of first broadcast/publication. - * - * @param \DateTimeInterface|\DateTimeInterface[] $datePublished - * - * @return static - * - * @see http://schema.org/datePublished - */ - public function datePublished($datePublished) - { - return $this->setProperty('datePublished', $datePublished); - } - - /** - * A link to the page containing the comments of the CreativeWork. - * - * @param string|string[] $discussionUrl - * - * @return static - * - * @see http://schema.org/discussionUrl - */ - public function discussionUrl($discussionUrl) - { - return $this->setProperty('discussionUrl', $discussionUrl); - } - - /** - * Specifies the Person who edited the CreativeWork. - * - * @param Person|Person[] $editor - * - * @return static - * - * @see http://schema.org/editor + * @see http://schema.org/editor */ public function editor($editor) { @@ -947,6 +748,49 @@ public function encodings($encodings) return $this->setProperty('encodings', $encodings); } + /** + * The end date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $endDate + * + * @return static + * + * @see http://schema.org/endDate + */ + public function endDate($endDate) + { + return $this->setProperty('endDate', $endDate); + } + + /** + * An episode of a tv, radio or game media within a series or season. + * + * @param Episode|Episode[] $episode + * + * @return static + * + * @see http://schema.org/episode + */ + public function episode($episode) + { + return $this->setProperty('episode', $episode); + } + + /** + * An episode of a TV/radio series or season. + * + * @param Episode|Episode[] $episodes + * + * @return static + * + * @see http://schema.org/episodes + */ + public function episodes($episodes) + { + return $this->setProperty('episodes', $episodes); + } + /** * A creative work that this work is an * example/instance/realization/derivation of. @@ -1016,6 +860,51 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * An item is an object within the game world that can be collected by a + * player or, occasionally, a non-player character. + * + * @param Thing|Thing[] $gameItem + * + * @return static + * + * @see http://schema.org/gameItem + */ + public function gameItem($gameItem) + { + return $this->setProperty('gameItem', $gameItem); + } + + /** + * Real or fictional location of the game (or part of game). + * + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $gameLocation + * + * @return static + * + * @see http://schema.org/gameLocation + */ + public function gameLocation($gameLocation) + { + return $this->setProperty('gameLocation', $gameLocation); + } + + /** + * The electronic systems used to play video + * games. + * + * @param Thing|Thing[]|string|string[] $gamePlatform + * + * @return static + * + * @see http://schema.org/gamePlatform + */ + public function gamePlatform($gamePlatform) + { + return $this->setProperty('gamePlatform', $gamePlatform); + } + /** * Genre of the creative work, broadcast channel or group. * @@ -1034,29 +923,62 @@ public function genre($genre) * Indicates an item or CreativeWork that is part of this item, or * CreativeWork (in some sense). * - * @param CreativeWork|CreativeWork[] $hasPart + * @param CreativeWork|CreativeWork[] $hasPart + * + * @return static + * + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/hasPart + * @see http://schema.org/identifier */ - public function hasPart($hasPart) + public function identifier($identifier) { - return $this->setProperty('hasPart', $hasPart); + return $this->setProperty('identifier', $identifier); } /** - * Headline of the article. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $headline + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/headline + * @see http://schema.org/image */ - public function headline($headline) + public function image($image) { - return $this->setProperty('headline', $headline); + return $this->setProperty('image', $image); } /** @@ -1181,6 +1103,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -1256,6 +1194,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1286,6 +1240,76 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * The number of episodes in this season or series. + * + * @param int|int[] $numberOfEpisodes + * + * @return static + * + * @see http://schema.org/numberOfEpisodes + */ + public function numberOfEpisodes($numberOfEpisodes) + { + return $this->setProperty('numberOfEpisodes', $numberOfEpisodes); + } + + /** + * Indicate how many people can play this game (minimum, maximum, or range). + * + * @param QuantitativeValue|QuantitativeValue[] $numberOfPlayers + * + * @return static + * + * @see http://schema.org/numberOfPlayers + */ + public function numberOfPlayers($numberOfPlayers) + { + return $this->setProperty('numberOfPlayers', $numberOfPlayers); + } + + /** + * The number of seasons in this series. + * + * @param int|int[] $numberOfSeasons + * + * @return static + * + * @see http://schema.org/numberOfSeasons + */ + public function numberOfSeasons($numberOfSeasons) + { + return $this->setProperty('numberOfSeasons', $numberOfSeasons); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1302,6 +1326,22 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Indicates whether this game is multi-player, co-op or single-player. The + * game can be marked as multi-player, co-op and single-player at the same + * time. + * + * @param GamePlayMode|GamePlayMode[] $playMode + * + * @return static + * + * @see http://schema.org/playMode + */ + public function playMode($playMode) + { + return $this->setProperty('playMode', $playMode); + } + /** * The position of an item in a series or sequence of items. * @@ -1316,6 +1356,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1331,6 +1386,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1399,6 +1469,21 @@ public function publishingPrinciples($publishingPrinciples) return $this->setProperty('publishingPrinciples', $publishingPrinciples); } + /** + * The task that a player-controlled character, or group of characters may + * complete in order to gain a reward. + * + * @param Thing|Thing[] $quest + * + * @return static + * + * @see http://schema.org/quest + */ + public function quest($quest) + { + return $this->setProperty('quest', $quest); + } + /** * The Event where the CreativeWork was recorded. The CreativeWork may * capture all or part of the event. @@ -1457,6 +1542,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1474,6 +1575,34 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * A season in a media series. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $season + * + * @return static + * + * @see http://schema.org/season + */ + public function season($season) + { + return $this->setProperty('season', $season); + } + + /** + * A season in a media series. + * + * @param CreativeWorkSeason|CreativeWorkSeason[] $seasons + * + * @return static + * + * @see http://schema.org/seasons + */ + public function seasons($seasons) + { + return $this->setProperty('seasons', $seasons); + } + /** * The Organization on whose behalf the creator was working. * @@ -1512,31 +1641,60 @@ public function spatial($spatial) * areas that the dataset describes: a dataset of New York weather * would have spatialCoverage which was the place: the state of New York. * - * @param Place|Place[] $spatialCoverage + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The start date and time of the item (in [ISO 8601 date + * format](http://en.wikipedia.org/wiki/ISO_8601)). + * + * @param \DateTimeInterface|\DateTimeInterface[] $startDate * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/startDate */ - public function spatialCoverage($spatialCoverage) + public function startDate($startDate) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('startDate', $startDate); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/subjectOf */ - public function sponsor($sponsor) + public function subjectOf($subjectOf) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('subjectOf', $subjectOf); } /** @@ -1630,6 +1788,20 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * The trailer of a movie or tv/radio series, season, episode, etc. + * + * @param VideoObject|VideoObject[] $trailer + * + * @return static + * + * @see http://schema.org/trailer + */ + public function trailer($trailer) + { + return $this->setProperty('trailer', $trailer); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1660,6 +1832,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1703,206 +1889,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - } diff --git a/src/VideoObject.php b/src/VideoObject.php index f4057008f..cc2b8603d 100644 --- a/src/VideoObject.php +++ b/src/VideoObject.php @@ -14,433 +14,6 @@ */ class VideoObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract { - /** - * 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. - * - * @param Person|Person[] $actor - * - * @return static - * - * @see http://schema.org/actor - */ - public function actor($actor) - { - return $this->setProperty('actor', $actor); - } - - /** - * An actor, e.g. in tv, radio, movie, video games etc. Actors can be - * associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $actors - * - * @return static - * - * @see http://schema.org/actors - */ - public function actors($actors) - { - return $this->setProperty('actors', $actors); - } - - /** - * The caption for this object. For downloadable machine formats (closed - * caption, subtitles etc.) use MediaObject and indicate the - * [[encodingFormat]]. - * - * @param MediaObject|MediaObject[]|string|string[] $caption - * - * @return static - * - * @see http://schema.org/caption - */ - public function caption($caption) - { - return $this->setProperty('caption', $caption); - } - - /** - * 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. - * - * @param Person|Person[] $director - * - * @return static - * - * @see http://schema.org/director - */ - public function director($director) - { - return $this->setProperty('director', $director); - } - - /** - * A director of e.g. tv, radio, movie, video games etc. content. Directors - * can be associated with individual items or with a series, episode, clip. - * - * @param Person|Person[] $directors - * - * @return static - * - * @see http://schema.org/directors - */ - public function directors($directors) - { - return $this->setProperty('directors', $directors); - } - - /** - * The composer of the soundtrack. - * - * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy - * - * @return static - * - * @see http://schema.org/musicBy - */ - public function musicBy($musicBy) - { - return $this->setProperty('musicBy', $musicBy); - } - - /** - * Thumbnail image for an image or video. - * - * @param ImageObject|ImageObject[] $thumbnail - * - * @return static - * - * @see http://schema.org/thumbnail - */ - public function thumbnail($thumbnail) - { - return $this->setProperty('thumbnail', $thumbnail); - } - - /** - * If this MediaObject is an AudioObject or VideoObject, the transcript of - * that object. - * - * @param string|string[] $transcript - * - * @return static - * - * @see http://schema.org/transcript - */ - public function transcript($transcript) - { - return $this->setProperty('transcript', $transcript); - } - - /** - * The frame size of the video. - * - * @param string|string[] $videoFrameSize - * - * @return static - * - * @see http://schema.org/videoFrameSize - */ - public function videoFrameSize($videoFrameSize) - { - return $this->setProperty('videoFrameSize', $videoFrameSize); - } - - /** - * The quality of the video. - * - * @param string|string[] $videoQuality - * - * @return static - * - * @see http://schema.org/videoQuality - */ - public function videoQuality($videoQuality) - { - return $this->setProperty('videoQuality', $videoQuality); - } - - /** - * A NewsArticle associated with the Media Object. - * - * @param NewsArticle|NewsArticle[] $associatedArticle - * - * @return static - * - * @see http://schema.org/associatedArticle - */ - public function associatedArticle($associatedArticle) - { - return $this->setProperty('associatedArticle', $associatedArticle); - } - - /** - * The bitrate of the media object. - * - * @param string|string[] $bitrate - * - * @return static - * - * @see http://schema.org/bitrate - */ - public function bitrate($bitrate) - { - return $this->setProperty('bitrate', $bitrate); - } - - /** - * File size in (mega/kilo) bytes. - * - * @param string|string[] $contentSize - * - * @return static - * - * @see http://schema.org/contentSize - */ - public function contentSize($contentSize) - { - return $this->setProperty('contentSize', $contentSize); - } - - /** - * Actual bytes of the media object, for example the image file or video - * file. - * - * @param string|string[] $contentUrl - * - * @return static - * - * @see http://schema.org/contentUrl - */ - public function contentUrl($contentUrl) - { - return $this->setProperty('contentUrl', $contentUrl); - } - - /** - * The duration of the item (movie, audio recording, event, etc.) in [ISO - * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). - * - * @param Duration|Duration[] $duration - * - * @return static - * - * @see http://schema.org/duration - */ - public function duration($duration) - { - return $this->setProperty('duration', $duration); - } - - /** - * A URL pointing to a player for a specific video. In general, this is the - * information in the ```src``` element of an ```embed``` tag and should not - * be the same as the content of the ```loc``` tag. - * - * @param string|string[] $embedUrl - * - * @return static - * - * @see http://schema.org/embedUrl - */ - public function embedUrl($embedUrl) - { - return $this->setProperty('embedUrl', $embedUrl); - } - - /** - * The CreativeWork encoded by this media object. - * - * @param CreativeWork|CreativeWork[] $encodesCreativeWork - * - * @return static - * - * @see http://schema.org/encodesCreativeWork - */ - public function encodesCreativeWork($encodesCreativeWork) - { - return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); - } - - /** - * Media type typically expressed using a MIME format (see [IANA - * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and - * [MDN - * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) - * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for - * .mp3 etc.). - * - * In cases where a [[CreativeWork]] has several media type representations, - * [[encoding]] can be used to indicate each [[MediaObject]] alongside - * particular [[encodingFormat]] information. - * - * Unregistered or niche encoding and file formats can be indicated instead - * via the most appropriate URL, e.g. defining Web page or a - * Wikipedia/Wikidata entry. - * - * @param string|string[] $encodingFormat - * - * @return static - * - * @see http://schema.org/encodingFormat - */ - public function encodingFormat($encodingFormat) - { - return $this->setProperty('encodingFormat', $encodingFormat); - } - - /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime - * - * @return static - * - * @see http://schema.org/endTime - */ - public function endTime($endTime) - { - return $this->setProperty('endTime', $endTime); - } - - /** - * The height of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height - * - * @return static - * - * @see http://schema.org/height - */ - public function height($height) - { - return $this->setProperty('height', $height); - } - - /** - * Player type required—for example, Flash or Silverlight. - * - * @param string|string[] $playerType - * - * @return static - * - * @see http://schema.org/playerType - */ - public function playerType($playerType) - { - return $this->setProperty('playerType', $playerType); - } - - /** - * The production company or studio responsible for the item e.g. series, - * video game, episode etc. - * - * @param Organization|Organization[] $productionCompany - * - * @return static - * - * @see http://schema.org/productionCompany - */ - public function productionCompany($productionCompany) - { - return $this->setProperty('productionCompany', $productionCompany); - } - - /** - * The regions where the media is allowed. If not specified, then it's - * assumed to be allowed everywhere. Specify the countries in [ISO 3166 - * format](http://en.wikipedia.org/wiki/ISO_3166). - * - * @param Place|Place[] $regionsAllowed - * - * @return static - * - * @see http://schema.org/regionsAllowed - */ - public function regionsAllowed($regionsAllowed) - { - return $this->setProperty('regionsAllowed', $regionsAllowed); - } - - /** - * Indicates if use of the media require a subscription (either paid or - * free). Allowed values are ```true``` or ```false``` (note that an earlier - * version had 'yes', 'no'). - * - * @param bool|bool[] $requiresSubscription - * - * @return static - * - * @see http://schema.org/requiresSubscription - */ - public function requiresSubscription($requiresSubscription) - { - return $this->setProperty('requiresSubscription', $requiresSubscription); - } - - /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. - * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime - * - * @return static - * - * @see http://schema.org/startTime - */ - public function startTime($startTime) - { - return $this->setProperty('startTime', $startTime); - } - - /** - * Date when this media object was uploaded to this site. - * - * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate - * - * @return static - * - * @see http://schema.org/uploadDate - */ - public function uploadDate($uploadDate) - { - return $this->setProperty('uploadDate', $uploadDate); - } - - /** - * The width of the item. - * - * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width - * - * @return static - * - * @see http://schema.org/width - */ - public function width($width) - { - return $this->setProperty('width', $width); - } - /** * The subject matter of the content. * @@ -560,29 +133,79 @@ public function accessibilityHazard($accessibilityHazard) * descriptions will be needed for non-visual users" or "short descriptions * are present and no long descriptions are needed." * - * @param string|string[] $accessibilitySummary + * @param string|string[] $accessibilitySummary + * + * @return static + * + * @see http://schema.org/accessibilitySummary + */ + public function accessibilitySummary($accessibilitySummary) + { + return $this->setProperty('accessibilitySummary', $accessibilitySummary); + } + + /** + * Specifies the Person that is legally accountable for the CreativeWork. + * + * @param Person|Person[] $accountablePerson + * + * @return static + * + * @see http://schema.org/accountablePerson + */ + public function accountablePerson($accountablePerson) + { + return $this->setProperty('accountablePerson', $accountablePerson); + } + + /** + * 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. + * + * @param Person|Person[] $actor + * + * @return static + * + * @see http://schema.org/actor + */ + public function actor($actor) + { + return $this->setProperty('actor', $actor); + } + + /** + * An actor, e.g. in tv, radio, movie, video games etc. Actors can be + * associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $actors * * @return static * - * @see http://schema.org/accessibilitySummary + * @see http://schema.org/actors */ - public function accessibilitySummary($accessibilitySummary) + public function actors($actors) { - return $this->setProperty('accessibilitySummary', $accessibilitySummary); + return $this->setProperty('actors', $actors); } /** - * Specifies the Person that is legally accountable for the CreativeWork. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Person|Person[] $accountablePerson + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/accountablePerson + * @see http://schema.org/additionalType */ - public function accountablePerson($accountablePerson) + public function additionalType($additionalType) { - return $this->setProperty('accountablePerson', $accountablePerson); + return $this->setProperty('additionalType', $additionalType); } /** @@ -600,6 +223,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -614,6 +251,20 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * A NewsArticle associated with the Media Object. + * + * @param NewsArticle|NewsArticle[] $associatedArticle + * + * @return static + * + * @see http://schema.org/associatedArticle + */ + public function associatedArticle($associatedArticle) + { + return $this->setProperty('associatedArticle', $associatedArticle); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -701,6 +352,36 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * The bitrate of the media object. + * + * @param string|string[] $bitrate + * + * @return static + * + * @see http://schema.org/bitrate + */ + public function bitrate($bitrate) + { + return $this->setProperty('bitrate', $bitrate); + } + + /** + * The caption for this object. For downloadable machine formats (closed + * caption, subtitles etc.) use MediaObject and indicate the + * [[encodingFormat]]. + * + * @param MediaObject|MediaObject[]|string|string[] $caption + * + * @return static + * + * @see http://schema.org/caption + */ + public function caption($caption) + { + return $this->setProperty('caption', $caption); + } + /** * Fictional person connected with a creative work. * @@ -789,6 +470,35 @@ public function contentRating($contentRating) return $this->setProperty('contentRating', $contentRating); } + /** + * File size in (mega/kilo) bytes. + * + * @param string|string[] $contentSize + * + * @return static + * + * @see http://schema.org/contentSize + */ + public function contentSize($contentSize) + { + return $this->setProperty('contentSize', $contentSize); + } + + /** + * Actual bytes of the media object, for example the image file or video + * file. + * + * @param string|string[] $contentUrl + * + * @return static + * + * @see http://schema.org/contentUrl + */ + public function contentUrl($contentUrl) + { + return $this->setProperty('contentUrl', $contentUrl); + } + /** * A secondary contributor to the CreativeWork or Event. * @@ -891,6 +601,68 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param Person|Person[] $director + * + * @return static + * + * @see http://schema.org/director + */ + public function director($director) + { + return $this->setProperty('director', $director); + } + + /** + * A director of e.g. tv, radio, movie, video games etc. content. Directors + * can be associated with individual items or with a series, episode, clip. + * + * @param Person|Person[] $directors + * + * @return static + * + * @see http://schema.org/directors + */ + public function directors($directors) + { + return $this->setProperty('directors', $directors); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -905,6 +677,21 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * The duration of the item (movie, audio recording, event, etc.) in [ISO + * 8601 date format](http://en.wikipedia.org/wiki/ISO_8601). + * + * @param Duration|Duration[] $duration + * + * @return static + * + * @see http://schema.org/duration + */ + public function duration($duration) + { + return $this->setProperty('duration', $duration); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -937,44 +724,124 @@ public function educationalAlignment($educationalAlignment) * The purpose of a work in the context of education; for example, * 'assignment', 'group work'. * - * @param string|string[] $educationalUse + * @param string|string[] $educationalUse + * + * @return static + * + * @see http://schema.org/educationalUse + */ + public function educationalUse($educationalUse) + { + return $this->setProperty('educationalUse', $educationalUse); + } + + /** + * A URL pointing to a player for a specific video. In general, this is the + * information in the ```src``` element of an ```embed``` tag and should not + * be the same as the content of the ```loc``` tag. + * + * @param string|string[] $embedUrl + * + * @return static + * + * @see http://schema.org/embedUrl + */ + public function embedUrl($embedUrl) + { + return $this->setProperty('embedUrl', $embedUrl); + } + + /** + * The CreativeWork encoded by this media object. + * + * @param CreativeWork|CreativeWork[] $encodesCreativeWork + * + * @return static + * + * @see http://schema.org/encodesCreativeWork + */ + public function encodesCreativeWork($encodesCreativeWork) + { + return $this->setProperty('encodesCreativeWork', $encodesCreativeWork); + } + + /** + * A media object that encodes this CreativeWork. This property is a synonym + * for associatedMedia. + * + * @param MediaObject|MediaObject[] $encoding + * + * @return static + * + * @see http://schema.org/encoding + */ + public function encoding($encoding) + { + return $this->setProperty('encoding', $encoding); + } + + /** + * Media type typically expressed using a MIME format (see [IANA + * site](http://www.iana.org/assignments/media-types/media-types.xhtml) and + * [MDN + * reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)) + * e.g. application/zip for a SoftwareApplication binary, audio/mpeg for + * .mp3 etc.). + * + * In cases where a [[CreativeWork]] has several media type representations, + * [[encoding]] can be used to indicate each [[MediaObject]] alongside + * particular [[encodingFormat]] information. + * + * Unregistered or niche encoding and file formats can be indicated instead + * via the most appropriate URL, e.g. defining Web page or a + * Wikipedia/Wikidata entry. + * + * @param string|string[] $encodingFormat * * @return static * - * @see http://schema.org/educationalUse + * @see http://schema.org/encodingFormat */ - public function educationalUse($educationalUse) + public function encodingFormat($encodingFormat) { - return $this->setProperty('educationalUse', $educationalUse); + return $this->setProperty('encodingFormat', $encodingFormat); } /** - * A media object that encodes this CreativeWork. This property is a synonym - * for associatedMedia. + * A media object that encodes this CreativeWork. * - * @param MediaObject|MediaObject[] $encoding + * @param MediaObject|MediaObject[] $encodings * * @return static * - * @see http://schema.org/encoding + * @see http://schema.org/encodings */ - public function encoding($encoding) + public function encodings($encodings) { - return $this->setProperty('encoding', $encoding); + return $this->setProperty('encodings', $encodings); } /** - * A media object that encodes this CreativeWork. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param MediaObject|MediaObject[] $encodings + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/encodings + * @see http://schema.org/endTime */ - public function encodings($encodings) + public function endTime($endTime) { - return $this->setProperty('encodings', $encodings); + return $this->setProperty('endTime', $endTime); } /** @@ -1089,6 +956,53 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * The height of the item. + * + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $height + * + * @return static + * + * @see http://schema.org/height + */ + public function height($height) + { + return $this->setProperty('height', $height); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -1286,6 +1200,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1316,6 +1246,34 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The composer of the soundtrack. + * + * @param MusicGroup|MusicGroup[]|Person|Person[] $musicBy + * + * @return static + * + * @see http://schema.org/musicBy + */ + public function musicBy($musicBy) + { + return $this->setProperty('musicBy', $musicBy); + } + + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1332,6 +1290,20 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Player type required—for example, Flash or Silverlight. + * + * @param string|string[] $playerType + * + * @return static + * + * @see http://schema.org/playerType + */ + public function playerType($playerType) + { + return $this->setProperty('playerType', $playerType); + } + /** * The position of an item in a series or sequence of items. * @@ -1346,6 +1318,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1361,6 +1348,21 @@ public function producer($producer) return $this->setProperty('producer', $producer); } + /** + * The production company or studio responsible for the item e.g. series, + * video game, episode etc. + * + * @param Organization|Organization[] $productionCompany + * + * @return static + * + * @see http://schema.org/productionCompany + */ + public function productionCompany($productionCompany) + { + return $this->setProperty('productionCompany', $productionCompany); + } + /** * The service provider, service operator, or service performer; the goods * producer. Another party (a seller) may offer those services or goods on @@ -1444,6 +1446,22 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * The regions where the media is allowed. If not specified, then it's + * assumed to be allowed everywhere. Specify the countries in [ISO 3166 + * format](http://en.wikipedia.org/wiki/ISO_3166). + * + * @param Place|Place[] $regionsAllowed + * + * @return static + * + * @see http://schema.org/regionsAllowed + */ + public function regionsAllowed($regionsAllowed) + { + return $this->setProperty('regionsAllowed', $regionsAllowed); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1459,6 +1477,22 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Indicates if use of the media require a subscription (either paid or + * free). Allowed values are ```true``` or ```false``` (note that an earlier + * version had 'yes', 'no'). + * + * @param bool|bool[] $requiresSubscription + * + * @return static + * + * @see http://schema.org/requiresSubscription + */ + public function requiresSubscription($requiresSubscription) + { + return $this->setProperty('requiresSubscription', $requiresSubscription); + } + /** * A review of the item. * @@ -1487,6 +1521,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1542,31 +1592,68 @@ public function spatial($spatial) * areas that the dataset describes: a dataset of New York weather * would have spatialCoverage which was the place: the state of New York. * - * @param Place|Place[] $spatialCoverage + * @param Place|Place[] $spatialCoverage + * + * @return static + * + * @see http://schema.org/spatialCoverage + */ + public function spatialCoverage($spatialCoverage) + { + return $this->setProperty('spatialCoverage', $spatialCoverage); + } + + /** + * 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. + * + * @param Organization|Organization[]|Person|Person[] $sponsor + * + * @return static + * + * @see http://schema.org/sponsor + */ + public function sponsor($sponsor) + { + return $this->setProperty('sponsor', $sponsor); + } + + /** + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. + * + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/spatialCoverage + * @see http://schema.org/startTime */ - public function spatialCoverage($spatialCoverage) + public function startTime($startTime) { - return $this->setProperty('spatialCoverage', $spatialCoverage); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/subjectOf */ - public function sponsor($sponsor) + public function subjectOf($subjectOf) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('subjectOf', $subjectOf); } /** @@ -1630,6 +1717,20 @@ public function text($text) return $this->setProperty('text', $text); } + /** + * Thumbnail image for an image or video. + * + * @param ImageObject|ImageObject[] $thumbnail + * + * @return static + * + * @see http://schema.org/thumbnail + */ + public function thumbnail($thumbnail) + { + return $this->setProperty('thumbnail', $thumbnail); + } + /** * A thumbnail image relevant to the Thing. * @@ -1660,6 +1761,21 @@ public function timeRequired($timeRequired) return $this->setProperty('timeRequired', $timeRequired); } + /** + * If this MediaObject is an AudioObject or VideoObject, the transcript of + * that object. + * + * @param string|string[] $transcript + * + * @return static + * + * @see http://schema.org/transcript + */ + public function transcript($transcript) + { + return $this->setProperty('transcript', $transcript); + } + /** * Organization or person who adapts a creative work to different languages, * regional differences and technical requirements of a target market, or @@ -1691,232 +1807,116 @@ public function typicalAgeRange($typicalAgeRange) } /** - * The version of the CreativeWork embodied by a specified resource. - * - * @param float|float[]|int|int[]|string|string[] $version - * - * @return static - * - * @see http://schema.org/version - */ - public function version($version) - { - return $this->setProperty('version', $version); - } - - /** - * An embedded video object. - * - * @param Clip|Clip[]|VideoObject|VideoObject[] $video - * - * @return static - * - * @see http://schema.org/video - */ - public function video($video) - { - return $this->setProperty('video', $video); - } - - /** - * Example/instance/realization/derivation of the concept of this creative - * work. eg. The paperback edition, first edition, or eBook. - * - * @param CreativeWork|CreativeWork[] $workExample - * - * @return static - * - * @see http://schema.org/workExample - */ - public function workExample($workExample) - { - return $this->setProperty('workExample', $workExample); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Date when this media object was uploaded to this site. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param \DateTimeInterface|\DateTimeInterface[] $uploadDate * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/uploadDate */ - public function identifier($identifier) + public function uploadDate($uploadDate) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('uploadDate', $uploadDate); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * URL of the item. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param string|string[] $url * * @return static * - * @see http://schema.org/image + * @see http://schema.org/url */ - public function image($image) + public function url($url) { - return $this->setProperty('image', $image); + return $this->setProperty('url', $url); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The version of the CreativeWork embodied by a specified resource. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param float|float[]|int|int[]|string|string[] $version * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/version */ - public function mainEntityOfPage($mainEntityOfPage) + public function version($version) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('version', $version); } /** - * The name of the item. + * An embedded video object. * - * @param string|string[] $name + * @param Clip|Clip[]|VideoObject|VideoObject[] $video * * @return static * - * @see http://schema.org/name + * @see http://schema.org/video */ - public function name($name) + public function video($video) { - return $this->setProperty('name', $name); + return $this->setProperty('video', $video); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The frame size of the video. * - * @param Action|Action[] $potentialAction + * @param string|string[] $videoFrameSize * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/videoFrameSize */ - public function potentialAction($potentialAction) + public function videoFrameSize($videoFrameSize) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('videoFrameSize', $videoFrameSize); } /** - * 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. + * The quality of the video. * - * @param string|string[] $sameAs + * @param string|string[] $videoQuality * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/videoQuality */ - public function sameAs($sameAs) + public function videoQuality($videoQuality) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('videoQuality', $videoQuality); } /** - * A CreativeWork or Event about this Thing. + * The width of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param Distance|Distance[]|QuantitativeValue|QuantitativeValue[] $width * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/width */ - public function subjectOf($subjectOf) + public function width($width) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('width', $width); } /** - * URL of the item. + * Example/instance/realization/derivation of the concept of this creative + * work. eg. The paperback edition, first edition, or eBook. * - * @param string|string[] $url + * @param CreativeWork|CreativeWork[] $workExample * * @return static * - * @see http://schema.org/url + * @see http://schema.org/workExample */ - public function url($url) + public function workExample($workExample) { - return $this->setProperty('url', $url); + return $this->setProperty('workExample', $workExample); } } diff --git a/src/ViewAction.php b/src/ViewAction.php index 167da341d..739022a0b 100644 --- a/src/ViewAction.php +++ b/src/ViewAction.php @@ -31,33 +31,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -76,325 +79,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/VisualArtsEvent.php b/src/VisualArtsEvent.php index 1b8b062d0..5b4adaa49 100644 --- a/src/VisualArtsEvent.php +++ b/src/VisualArtsEvent.php @@ -43,6 +43,25 @@ public function actor($actor) return $this->setProperty('actor', $actor); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -58,6 +77,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A person or organization attending the event. * @@ -129,6 +162,20 @@ public function contributor($contributor) return $this->setProperty('contributor', $contributor); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + /** * 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 @@ -145,6 +192,23 @@ public function director($director) return $this->setProperty('director', $director); } + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The time admission will commence. * @@ -219,6 +283,39 @@ public function funder($funder) return $this->setProperty('funder', $funder); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -265,6 +362,22 @@ public function location($location) return $this->setProperty('location', $location); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * The total number of individuals that may attend an event or venue. * @@ -279,6 +392,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -339,6 +466,21 @@ public function performers($performers) return $this->setProperty('performers', $performers); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * Used in conjunction with eventStatus for rescheduled or cancelled events. * This property contains the previously scheduled start date. For @@ -399,6 +541,22 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * 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 @@ -461,6 +619,20 @@ public function subEvents($subEvents) return $this->setProperty('subEvents', $subEvents); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * 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 @@ -507,6 +679,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * A work featured in some event, e.g. exhibited in an ExhibitionEvent. * Specific subproperties are available for workPerformed (e.g. a @@ -538,190 +724,4 @@ public function workPerformed($workPerformed) return $this->setProperty('workPerformed', $workPerformed); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/VisualArtwork.php b/src/VisualArtwork.php index 751c9bd27..b6e8368b0 100644 --- a/src/VisualArtwork.php +++ b/src/VisualArtwork.php @@ -13,83 +13,6 @@ */ class VisualArtwork extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The number of copies when multiple copies of a piece of artwork are - * produced - e.g. for a limited edition of 20 prints, 'artEdition' refers - * to the total number of copies (in this example "20"). - * - * @param int|int[]|string|string[] $artEdition - * - * @return static - * - * @see http://schema.org/artEdition - */ - public function artEdition($artEdition) - { - return $this->setProperty('artEdition', $artEdition); - } - - /** - * The material used. (e.g. Oil, Watercolour, Acrylic, Linoprint, Marble, - * Cyanotype, Digital, Lithograph, DryPoint, Intaglio, Pastel, Woodcut, - * Pencil, Mixed Media, etc.) - * - * @param string|string[] $artMedium - * - * @return static - * - * @see http://schema.org/artMedium - */ - public function artMedium($artMedium) - { - return $this->setProperty('artMedium', $artMedium); - } - - /** - * e.g. Painting, Drawing, Sculpture, Print, Photograph, Assemblage, - * Collage, etc. - * - * @param string|string[] $artform - * - * @return static - * - * @see http://schema.org/artform - */ - public function artform($artform) - { - return $this->setProperty('artform', $artform); - } - - /** - * The supporting materials for the artwork, e.g. Canvas, Paper, Wood, - * Board, etc. - * - * @param string|string[] $artworkSurface - * - * @return static - * - * @see http://schema.org/artworkSurface - */ - public function artworkSurface($artworkSurface) - { - return $this->setProperty('artworkSurface', $artworkSurface); - } - - /** - * A material used as a surface in some artwork, e.g. Canvas, Paper, Wood, - * Board, etc. - * - * @param string|string[] $surface - * - * @return static - * - * @see http://schema.org/surface - */ - public function surface($surface) - { - return $this->setProperty('surface', $surface); - } - /** * The subject matter of the content. * @@ -234,6 +157,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -249,6 +191,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -263,6 +219,68 @@ public function alternativeHeadline($alternativeHeadline) return $this->setProperty('alternativeHeadline', $alternativeHeadline); } + /** + * The number of copies when multiple copies of a piece of artwork are + * produced - e.g. for a limited edition of 20 prints, 'artEdition' refers + * to the total number of copies (in this example "20"). + * + * @param int|int[]|string|string[] $artEdition + * + * @return static + * + * @see http://schema.org/artEdition + */ + public function artEdition($artEdition) + { + return $this->setProperty('artEdition', $artEdition); + } + + /** + * The material used. (e.g. Oil, Watercolour, Acrylic, Linoprint, Marble, + * Cyanotype, Digital, Lithograph, DryPoint, Intaglio, Pastel, Woodcut, + * Pencil, Mixed Media, etc.) + * + * @param string|string[] $artMedium + * + * @return static + * + * @see http://schema.org/artMedium + */ + public function artMedium($artMedium) + { + return $this->setProperty('artMedium', $artMedium); + } + + /** + * e.g. Painting, Drawing, Sculpture, Print, Photograph, Assemblage, + * Collage, etc. + * + * @param string|string[] $artform + * + * @return static + * + * @see http://schema.org/artform + */ + public function artform($artform) + { + return $this->setProperty('artform', $artform); + } + + /** + * The supporting materials for the artwork, e.g. Canvas, Paper, Wood, + * Board, etc. + * + * @param string|string[] $artworkSurface + * + * @return static + * + * @see http://schema.org/artworkSurface + */ + public function artworkSurface($artworkSurface) + { + return $this->setProperty('artworkSurface', $artworkSurface); + } + /** * A media object that encodes this CreativeWork. This property is a synonym * for encoding. @@ -540,6 +558,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -765,6 +814,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -962,6 +1044,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -993,9 +1091,23 @@ public function mentions($mentions) } /** - * An offer to provide this item—for example, an offer to sell a - * product, rent the DVD of a movie, perform a service, or give away tickets - * to an event. + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * An offer to provide this item—for example, an offer to sell a + * product, rent the DVD of a movie, perform a service, or give away tickets + * to an event. * * @param Offer|Offer[] $offers * @@ -1022,6 +1134,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1163,6 +1290,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1245,6 +1388,35 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * A material used as a surface in some artwork, e.g. Canvas, Paper, Wood, + * Board, etc. + * + * @param string|string[] $surface + * + * @return static + * + * @see http://schema.org/surface + */ + public function surface($surface) + { + return $this->setProperty('surface', $surface); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1366,6 +1538,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1409,190 +1595,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/Volcano.php b/src/Volcano.php index 9d78acbc1..a344d6d06 100644 --- a/src/Volcano.php +++ b/src/Volcano.php @@ -36,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -65,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -145,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -233,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -307,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -349,6 +462,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -391,6 +518,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -434,6 +576,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -481,189 +639,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/VoteAction.php b/src/VoteAction.php index a2e09a333..6fbe06f73 100644 --- a/src/VoteAction.php +++ b/src/VoteAction.php @@ -16,20 +16,6 @@ */ class VoteAction extends BaseType implements ChooseActionContract, AssessActionContract, ActionContract, ThingContract { - /** - * A sub property of object. The candidate subject of this action. - * - * @param Person|Person[] $candidate - * - * @return static - * - * @see http://schema.org/candidate - */ - public function candidate($candidate) - { - return $this->setProperty('candidate', $candidate); - } - /** * A sub property of object. The options subject to this action. * @@ -45,31 +31,36 @@ public function actionOption($actionOption) } /** - * A sub property of object. The options subject to this action. + * Indicates the current disposition of the Action. * - * @param Thing|Thing[]|string|string[] $option + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/option + * @see http://schema.org/actionStatus */ - public function option($option) + public function actionStatus($actionStatus) { - return $this->setProperty('option', $option); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -88,311 +79,306 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A sub property of object. The candidate subject of this action. * - * @param Thing|Thing[] $error + * @param Person|Person[] $candidate * * @return static * - * @see http://schema.org/error + * @see http://schema.org/candidate */ - public function error($error) + public function candidate($candidate) { - return $this->setProperty('error', $error); + return $this->setProperty('candidate', $candidate); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * A sub property of object. The options subject to this action. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Thing|Thing[]|string|string[] $option * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/option */ - public function identifier($identifier) + public function option($option) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('option', $option); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/image + * @see http://schema.org/participant */ - public function image($image) + public function participant($participant) { - return $this->setProperty('image', $image); + return $this->setProperty('participant', $participant); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/potentialAction */ - public function mainEntityOfPage($mainEntityOfPage) + public function potentialAction($potentialAction) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The name of the item. + * The result produced in the action. e.g. John wrote *a book*. * - * @param string|string[] $name + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/name + * @see http://schema.org/result */ - public function name($name) + public function result($result) { - return $this->setProperty('name', $name); + return $this->setProperty('result', $result); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * 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. * - * @param Action|Action[] $potentialAction + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/sameAs */ - public function potentialAction($potentialAction) + public function sameAs($sameAs) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('sameAs', $sameAs); } /** - * 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. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/startTime */ - public function sameAs($sameAs) + public function startTime($startTime) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('startTime', $startTime); } /** @@ -409,6 +395,20 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + /** * URL of the item. * diff --git a/src/WPAdBlock.php b/src/WPAdBlock.php index c98ba1b7f..0006072fd 100644 --- a/src/WPAdBlock.php +++ b/src/WPAdBlock.php @@ -11,6 +11,8 @@ * * @see http://schema.org/WPAdBlock * + * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] + * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ class WPAdBlock extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { @@ -158,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -173,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -464,6 +499,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -689,6 +755,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -886,6 +985,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -916,6 +1031,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -946,6 +1075,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1087,6 +1231,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1169,6 +1329,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1290,6 +1464,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1333,190 +1521,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/WPFooter.php b/src/WPFooter.php index 45feedf3e..7a3264894 100644 --- a/src/WPFooter.php +++ b/src/WPFooter.php @@ -11,6 +11,8 @@ * * @see http://schema.org/WPFooter * + * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] + * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ class WPFooter extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { @@ -158,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -173,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -464,6 +499,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -689,6 +755,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -886,6 +985,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -916,6 +1031,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -946,6 +1075,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1087,6 +1231,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1169,6 +1329,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1290,6 +1464,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1333,190 +1521,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/WPHeader.php b/src/WPHeader.php index b554de307..b4afe852f 100644 --- a/src/WPHeader.php +++ b/src/WPHeader.php @@ -11,6 +11,8 @@ * * @see http://schema.org/WPHeader * + * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] + * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ class WPHeader extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { @@ -158,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -173,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -464,6 +499,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -689,6 +755,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -886,6 +985,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -916,6 +1031,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -946,6 +1075,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1087,6 +1231,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1169,6 +1329,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1290,6 +1464,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1333,190 +1521,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/WPSideBar.php b/src/WPSideBar.php index d8ce9c1b1..b35f63484 100644 --- a/src/WPSideBar.php +++ b/src/WPSideBar.php @@ -11,6 +11,8 @@ * * @see http://schema.org/WPSideBar * + * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] + * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ class WPSideBar extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract { @@ -158,6 +160,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -173,6 +194,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -464,6 +499,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -689,6 +755,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -886,6 +985,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -916,6 +1031,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -946,6 +1075,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1087,6 +1231,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1169,6 +1329,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1290,6 +1464,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1333,190 +1521,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/WantAction.php b/src/WantAction.php index a1e954105..45b223ebe 100644 --- a/src/WantAction.php +++ b/src/WantAction.php @@ -30,340 +30,340 @@ public function actionStatus($actionStatus) } /** - * The direct performer or driver of the action (animate or inanimate). e.g. - * *John* wrote a book. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Organization|Organization[]|Person|Person[] $agent + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/agent + * @see http://schema.org/additionalType */ - public function agent($agent) + public function additionalType($additionalType) { - return $this->setProperty('agent', $agent); + return $this->setProperty('additionalType', $additionalType); } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The direct performer or driver of the action (animate or inanimate). e.g. + * *John* wrote a book. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param Organization|Organization[]|Person|Person[] $agent * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/agent */ - public function endTime($endTime) + public function agent($agent) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('agent', $agent); } /** - * For failed actions, more information on the cause of the failure. + * An alias for the item. * - * @param Thing|Thing[] $error + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/error + * @see http://schema.org/alternateName */ - public function error($error) + public function alternateName($alternateName) { - return $this->setProperty('error', $error); + return $this->setProperty('alternateName', $alternateName); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * A description of the item. * - * @param Thing|Thing[] $instrument + * @param string|string[] $description * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/description */ - public function instrument($instrument) + public function description($description) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('description', $description); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * 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. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/location + * @see http://schema.org/disambiguatingDescription */ - public function location($location) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('location', $location); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Thing|Thing[] $object + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/object + * @see http://schema.org/endTime */ - public function object($object) + public function endTime($endTime) { - return $this->setProperty('object', $object); + return $this->setProperty('endTime', $endTime); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * For failed actions, more information on the cause of the failure. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/error */ - public function participant($participant) + public function error($error) { - return $this->setProperty('participant', $participant); + return $this->setProperty('error', $error); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/WarrantyPromise.php b/src/WarrantyPromise.php index 0eb487ea7..db707c672 100644 --- a/src/WarrantyPromise.php +++ b/src/WarrantyPromise.php @@ -16,35 +16,6 @@ */ class WarrantyPromise extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract { - /** - * The duration of the warranty promise. Common unitCode values are ANN for - * year, MON for months, or DAY for days. - * - * @param QuantitativeValue|QuantitativeValue[] $durationOfWarranty - * - * @return static - * - * @see http://schema.org/durationOfWarranty - */ - public function durationOfWarranty($durationOfWarranty) - { - return $this->setProperty('durationOfWarranty', $durationOfWarranty); - } - - /** - * The scope of the warranty promise. - * - * @param WarrantyScope|WarrantyScope[] $warrantyScope - * - * @return static - * - * @see http://schema.org/warrantyScope - */ - public function warrantyScope($warrantyScope) - { - return $this->setProperty('warrantyScope', $warrantyScope); - } - /** * An additional type for the item, typically used for adding more specific * types from external vocabularies in microdata syntax. This is a @@ -109,6 +80,21 @@ public function disambiguatingDescription($disambiguatingDescription) return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } + /** + * The duration of the warranty promise. Common unitCode values are ANN for + * year, MON for months, or DAY for days. + * + * @param QuantitativeValue|QuantitativeValue[] $durationOfWarranty + * + * @return static + * + * @see http://schema.org/durationOfWarranty + */ + public function durationOfWarranty($durationOfWarranty) + { + return $this->setProperty('durationOfWarranty', $durationOfWarranty); + } + /** * The identifier property represents any kind of identifier for any kind of * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides @@ -231,4 +217,18 @@ public function url($url) return $this->setProperty('url', $url); } + /** + * The scope of the warranty promise. + * + * @param WarrantyScope|WarrantyScope[] $warrantyScope + * + * @return static + * + * @see http://schema.org/warrantyScope + */ + public function warrantyScope($warrantyScope) + { + return $this->setProperty('warrantyScope', $warrantyScope); + } + } diff --git a/src/WatchAction.php b/src/WatchAction.php index 0c6c100be..b5a861cbf 100644 --- a/src/WatchAction.php +++ b/src/WatchAction.php @@ -31,33 +31,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -76,325 +79,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Waterfall.php b/src/Waterfall.php index c75a9c139..a45ebc557 100644 --- a/src/Waterfall.php +++ b/src/Waterfall.php @@ -37,6 +37,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -66,6 +85,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -146,6 +179,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -234,6 +298,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -308,6 +405,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -350,6 +463,20 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The opening hours of a certain place. * @@ -392,6 +519,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -435,6 +577,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -482,189 +640,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** diff --git a/src/WearAction.php b/src/WearAction.php index 6c97209f9..2dc1d90e8 100644 --- a/src/WearAction.php +++ b/src/WearAction.php @@ -32,33 +32,36 @@ public function actionAccessibilityRequirement($actionAccessibilityRequirement) } /** - * An Offer which must be accepted before the user can perform the Action. - * For example, the user may need to buy a movie before being able to watch - * it. + * Indicates the current disposition of the Action. * - * @param Offer|Offer[] $expectsAcceptanceOf + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/expectsAcceptanceOf + * @see http://schema.org/actionStatus */ - public function expectsAcceptanceOf($expectsAcceptanceOf) + public function actionStatus($actionStatus) { - return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -77,325 +80,322 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * An Offer which must be accepted before the user can perform the Action. + * For example, the user may need to buy a movie before being able to watch + * it. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param Offer|Offer[] $expectsAcceptanceOf * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/expectsAcceptanceOf */ - public function participant($participant) + public function expectsAcceptanceOf($expectsAcceptanceOf) { - return $this->setProperty('participant', $participant); + return $this->setProperty('expectsAcceptanceOf', $expectsAcceptanceOf); } /** - * The result produced in the action. e.g. John wrote *a book*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Thing|Thing[] $result + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/result + * @see http://schema.org/identifier */ - public function result($result) + public function identifier($identifier) { - return $this->setProperty('result', $result); + return $this->setProperty('identifier', $identifier); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/image */ - public function startTime($startTime) + public function image($image) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('image', $image); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $additionalType + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/location */ - public function additionalType($additionalType) + public function location($location) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('location', $location); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/WebApplication.php b/src/WebApplication.php index b063f66c4..6dc0bff2a 100644 --- a/src/WebApplication.php +++ b/src/WebApplication.php @@ -15,542 +15,252 @@ class WebApplication extends BaseType implements SoftwareApplicationContract, CreativeWorkContract, ThingContract { /** - * Specifies browser requirements in human-readable text. For example, - * 'requires HTML5 support'. - * - * @param string|string[] $browserRequirements - * - * @return static - * - * @see http://schema.org/browserRequirements - */ - public function browserRequirements($browserRequirements) - { - return $this->setProperty('browserRequirements', $browserRequirements); - } - - /** - * Type of software application, e.g. 'Game, Multimedia'. - * - * @param string|string[] $applicationCategory - * - * @return static - * - * @see http://schema.org/applicationCategory - */ - public function applicationCategory($applicationCategory) - { - return $this->setProperty('applicationCategory', $applicationCategory); - } - - /** - * Subcategory of the application, e.g. 'Arcade Game'. - * - * @param string|string[] $applicationSubCategory - * - * @return static - * - * @see http://schema.org/applicationSubCategory - */ - public function applicationSubCategory($applicationSubCategory) - { - return $this->setProperty('applicationSubCategory', $applicationSubCategory); - } - - /** - * The name of the application suite to which the application belongs (e.g. - * Excel belongs to Office). - * - * @param string|string[] $applicationSuite - * - * @return static - * - * @see http://schema.org/applicationSuite - */ - public function applicationSuite($applicationSuite) - { - return $this->setProperty('applicationSuite', $applicationSuite); - } - - /** - * Device required to run the application. Used in cases where a specific - * make/model is required to run the application. - * - * @param string|string[] $availableOnDevice - * - * @return static - * - * @see http://schema.org/availableOnDevice - */ - public function availableOnDevice($availableOnDevice) - { - return $this->setProperty('availableOnDevice', $availableOnDevice); - } - - /** - * Countries for which the application is not supported. You can also - * provide the two-letter ISO 3166-1 alpha-2 country code. - * - * @param string|string[] $countriesNotSupported - * - * @return static - * - * @see http://schema.org/countriesNotSupported - */ - public function countriesNotSupported($countriesNotSupported) - { - return $this->setProperty('countriesNotSupported', $countriesNotSupported); - } - - /** - * Countries for which the application is supported. You can also provide - * the two-letter ISO 3166-1 alpha-2 country code. - * - * @param string|string[] $countriesSupported - * - * @return static - * - * @see http://schema.org/countriesSupported - */ - public function countriesSupported($countriesSupported) - { - return $this->setProperty('countriesSupported', $countriesSupported); - } - - /** - * Device required to run the application. Used in cases where a specific - * make/model is required to run the application. - * - * @param string|string[] $device - * - * @return static - * - * @see http://schema.org/device - */ - public function device($device) - { - return $this->setProperty('device', $device); - } - - /** - * If the file can be downloaded, URL to download the binary. - * - * @param string|string[] $downloadUrl - * - * @return static - * - * @see http://schema.org/downloadUrl - */ - public function downloadUrl($downloadUrl) - { - return $this->setProperty('downloadUrl', $downloadUrl); - } - - /** - * Features or modules provided by this application (and possibly required - * by other applications). - * - * @param string|string[] $featureList - * - * @return static - * - * @see http://schema.org/featureList - */ - public function featureList($featureList) - { - return $this->setProperty('featureList', $featureList); - } - - /** - * Size of the application / package (e.g. 18MB). In the absence of a unit - * (MB, KB etc.), KB will be assumed. - * - * @param string|string[] $fileSize - * - * @return static - * - * @see http://schema.org/fileSize - */ - public function fileSize($fileSize) - { - return $this->setProperty('fileSize', $fileSize); - } - - /** - * URL at which the app may be installed, if different from the URL of the - * item. - * - * @param string|string[] $installUrl - * - * @return static - * - * @see http://schema.org/installUrl - */ - public function installUrl($installUrl) - { - return $this->setProperty('installUrl', $installUrl); - } - - /** - * Minimum memory requirements. - * - * @param string|string[] $memoryRequirements - * - * @return static - * - * @see http://schema.org/memoryRequirements - */ - public function memoryRequirements($memoryRequirements) - { - return $this->setProperty('memoryRequirements', $memoryRequirements); - } - - /** - * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). - * - * @param string|string[] $operatingSystem - * - * @return static - * - * @see http://schema.org/operatingSystem - */ - public function operatingSystem($operatingSystem) - { - return $this->setProperty('operatingSystem', $operatingSystem); - } - - /** - * Permission(s) required to run the app (for example, a mobile app may - * require full internet access or may run only on wifi). - * - * @param string|string[] $permissions - * - * @return static - * - * @see http://schema.org/permissions - */ - public function permissions($permissions) - { - return $this->setProperty('permissions', $permissions); - } - - /** - * Processor architecture required to run the application (e.g. IA64). - * - * @param string|string[] $processorRequirements - * - * @return static - * - * @see http://schema.org/processorRequirements - */ - public function processorRequirements($processorRequirements) - { - return $this->setProperty('processorRequirements', $processorRequirements); - } - - /** - * Description of what changed in this version. - * - * @param string|string[] $releaseNotes - * - * @return static - * - * @see http://schema.org/releaseNotes - */ - public function releaseNotes($releaseNotes) - { - return $this->setProperty('releaseNotes', $releaseNotes); - } - - /** - * Component dependency requirements for application. This includes runtime - * environments and shared libraries that are not included in the - * application distribution package, but required to run the application - * (Examples: DirectX, Java or .NET runtime). - * - * @param string|string[] $requirements - * - * @return static - * - * @see http://schema.org/requirements - */ - public function requirements($requirements) - { - return $this->setProperty('requirements', $requirements); - } - - /** - * A link to a screenshot image of the app. - * - * @param ImageObject|ImageObject[]|string|string[] $screenshot - * - * @return static - * - * @see http://schema.org/screenshot - */ - public function screenshot($screenshot) - { - return $this->setProperty('screenshot', $screenshot); - } - - /** - * Additional content for a software application. - * - * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn - * - * @return static - * - * @see http://schema.org/softwareAddOn - */ - public function softwareAddOn($softwareAddOn) - { - return $this->setProperty('softwareAddOn', $softwareAddOn); - } - - /** - * Software application help. + * The subject matter of the content. * - * @param CreativeWork|CreativeWork[] $softwareHelp + * @param Thing|Thing[] $about * * @return static * - * @see http://schema.org/softwareHelp + * @see http://schema.org/about */ - public function softwareHelp($softwareHelp) + public function about($about) { - return $this->setProperty('softwareHelp', $softwareHelp); + return $this->setProperty('about', $about); } /** - * Component dependency requirements for application. This includes runtime - * environments and shared libraries that are not included in the - * application distribution package, but required to run the application - * (Examples: DirectX, Java or .NET runtime). + * The human sensory perceptual system or cognitive faculty through which a + * person may process or perceive information. Expected values include: + * auditory, tactile, textual, visual, colorDependent, chartOnVisual, + * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. * - * @param string|string[] $softwareRequirements + * @param string|string[] $accessMode * * @return static * - * @see http://schema.org/softwareRequirements + * @see http://schema.org/accessMode */ - public function softwareRequirements($softwareRequirements) + public function accessMode($accessMode) { - return $this->setProperty('softwareRequirements', $softwareRequirements); + return $this->setProperty('accessMode', $accessMode); } /** - * Version of the software instance. + * A list of single or combined accessModes that are sufficient to + * understand all the intellectual content of a resource. Expected values + * include: auditory, tactile, textual, visual. * - * @param string|string[] $softwareVersion + * @param ItemList|ItemList[] $accessModeSufficient * * @return static * - * @see http://schema.org/softwareVersion + * @see http://schema.org/accessModeSufficient */ - public function softwareVersion($softwareVersion) + public function accessModeSufficient($accessModeSufficient) { - return $this->setProperty('softwareVersion', $softwareVersion); + return $this->setProperty('accessModeSufficient', $accessModeSufficient); } /** - * Storage requirements (free space required). + * Indicates that the resource is compatible with the referenced + * accessibility API ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param string|string[] $storageRequirements + * @param string|string[] $accessibilityAPI * * @return static * - * @see http://schema.org/storageRequirements + * @see http://schema.org/accessibilityAPI */ - public function storageRequirements($storageRequirements) + public function accessibilityAPI($accessibilityAPI) { - return $this->setProperty('storageRequirements', $storageRequirements); + return $this->setProperty('accessibilityAPI', $accessibilityAPI); } /** - * Supporting data for a SoftwareApplication. + * Identifies input methods that are sufficient to fully control the + * described resource ([WebSchemas wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param DataFeed|DataFeed[] $supportingData + * @param string|string[] $accessibilityControl * * @return static * - * @see http://schema.org/supportingData + * @see http://schema.org/accessibilityControl */ - public function supportingData($supportingData) + public function accessibilityControl($accessibilityControl) { - return $this->setProperty('supportingData', $supportingData); + return $this->setProperty('accessibilityControl', $accessibilityControl); } /** - * The subject matter of the content. + * Content features of the resource, such as accessible media, alternatives + * and supported enhancements for accessibility ([WebSchemas wiki lists + * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param Thing|Thing[] $about + * @param string|string[] $accessibilityFeature * * @return static * - * @see http://schema.org/about + * @see http://schema.org/accessibilityFeature */ - public function about($about) + public function accessibilityFeature($accessibilityFeature) { - return $this->setProperty('about', $about); + return $this->setProperty('accessibilityFeature', $accessibilityFeature); } /** - * The human sensory perceptual system or cognitive faculty through which a - * person may process or perceive information. Expected values include: - * auditory, tactile, textual, visual, colorDependent, chartOnVisual, - * chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual. + * A characteristic of the described resource that is physiologically + * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas + * wiki lists possible + * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). * - * @param string|string[] $accessMode + * @param string|string[] $accessibilityHazard * * @return static * - * @see http://schema.org/accessMode + * @see http://schema.org/accessibilityHazard */ - public function accessMode($accessMode) + public function accessibilityHazard($accessibilityHazard) { - return $this->setProperty('accessMode', $accessMode); + return $this->setProperty('accessibilityHazard', $accessibilityHazard); } /** - * A list of single or combined accessModes that are sufficient to - * understand all the intellectual content of a resource. Expected values - * include: auditory, tactile, textual, visual. + * A human-readable summary of specific accessibility features or + * deficiencies, consistent with the other accessibility metadata but + * expressing subtleties such as "short descriptions are present but long + * descriptions will be needed for non-visual users" or "short descriptions + * are present and no long descriptions are needed." * - * @param ItemList|ItemList[] $accessModeSufficient + * @param string|string[] $accessibilitySummary * * @return static * - * @see http://schema.org/accessModeSufficient + * @see http://schema.org/accessibilitySummary */ - public function accessModeSufficient($accessModeSufficient) + public function accessibilitySummary($accessibilitySummary) { - return $this->setProperty('accessModeSufficient', $accessModeSufficient); + return $this->setProperty('accessibilitySummary', $accessibilitySummary); } /** - * Indicates that the resource is compatible with the referenced - * accessibility API ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * Specifies the Person that is legally accountable for the CreativeWork. * - * @param string|string[] $accessibilityAPI + * @param Person|Person[] $accountablePerson * * @return static * - * @see http://schema.org/accessibilityAPI + * @see http://schema.org/accountablePerson */ - public function accessibilityAPI($accessibilityAPI) + public function accountablePerson($accountablePerson) { - return $this->setProperty('accessibilityAPI', $accessibilityAPI); + return $this->setProperty('accountablePerson', $accountablePerson); } /** - * Identifies input methods that are sufficient to fully control the - * described resource ([WebSchemas wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $accessibilityControl + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/accessibilityControl + * @see http://schema.org/additionalType */ - public function accessibilityControl($accessibilityControl) + public function additionalType($additionalType) { - return $this->setProperty('accessibilityControl', $accessibilityControl); + return $this->setProperty('additionalType', $additionalType); } /** - * Content features of the resource, such as accessible media, alternatives - * and supported enhancements for accessibility ([WebSchemas wiki lists - * possible values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $accessibilityFeature + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/accessibilityFeature + * @see http://schema.org/aggregateRating */ - public function accessibilityFeature($accessibilityFeature) + public function aggregateRating($aggregateRating) { - return $this->setProperty('accessibilityFeature', $accessibilityFeature); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * A characteristic of the described resource that is physiologically - * dangerous to some users. Related to WCAG 2.0 guideline 2.3 ([WebSchemas - * wiki lists possible - * values](http://www.w3.org/wiki/WebSchemas/Accessibility)). + * An alias for the item. * - * @param string|string[] $accessibilityHazard + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/accessibilityHazard + * @see http://schema.org/alternateName */ - public function accessibilityHazard($accessibilityHazard) + public function alternateName($alternateName) { - return $this->setProperty('accessibilityHazard', $accessibilityHazard); + return $this->setProperty('alternateName', $alternateName); } /** - * A human-readable summary of specific accessibility features or - * deficiencies, consistent with the other accessibility metadata but - * expressing subtleties such as "short descriptions are present but long - * descriptions will be needed for non-visual users" or "short descriptions - * are present and no long descriptions are needed." + * A secondary title of the CreativeWork. * - * @param string|string[] $accessibilitySummary + * @param string|string[] $alternativeHeadline * * @return static * - * @see http://schema.org/accessibilitySummary + * @see http://schema.org/alternativeHeadline */ - public function accessibilitySummary($accessibilitySummary) + public function alternativeHeadline($alternativeHeadline) { - return $this->setProperty('accessibilitySummary', $accessibilitySummary); + return $this->setProperty('alternativeHeadline', $alternativeHeadline); } /** - * Specifies the Person that is legally accountable for the CreativeWork. + * Type of software application, e.g. 'Game, Multimedia'. * - * @param Person|Person[] $accountablePerson + * @param string|string[] $applicationCategory * * @return static * - * @see http://schema.org/accountablePerson + * @see http://schema.org/applicationCategory */ - public function accountablePerson($accountablePerson) + public function applicationCategory($applicationCategory) { - return $this->setProperty('accountablePerson', $accountablePerson); + return $this->setProperty('applicationCategory', $applicationCategory); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * Subcategory of the application, e.g. 'Arcade Game'. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param string|string[] $applicationSubCategory * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/applicationSubCategory */ - public function aggregateRating($aggregateRating) + public function applicationSubCategory($applicationSubCategory) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('applicationSubCategory', $applicationSubCategory); } /** - * A secondary title of the CreativeWork. + * The name of the application suite to which the application belongs (e.g. + * Excel belongs to Office). * - * @param string|string[] $alternativeHeadline + * @param string|string[] $applicationSuite * * @return static * - * @see http://schema.org/alternativeHeadline + * @see http://schema.org/applicationSuite */ - public function alternativeHeadline($alternativeHeadline) + public function applicationSuite($applicationSuite) { - return $this->setProperty('alternativeHeadline', $alternativeHeadline); + return $this->setProperty('applicationSuite', $applicationSuite); } /** @@ -612,6 +322,21 @@ public function author($author) return $this->setProperty('author', $author); } + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $availableOnDevice + * + * @return static + * + * @see http://schema.org/availableOnDevice + */ + public function availableOnDevice($availableOnDevice) + { + return $this->setProperty('availableOnDevice', $availableOnDevice); + } + /** * An award won by or for this item. * @@ -640,6 +365,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * Specifies browser requirements in human-readable text. For example, + * 'requires HTML5 support'. + * + * @param string|string[] $browserRequirements + * + * @return static + * + * @see http://schema.org/browserRequirements + */ + public function browserRequirements($browserRequirements) + { + return $this->setProperty('browserRequirements', $browserRequirements); + } + /** * Fictional person connected with a creative work. * @@ -771,6 +511,36 @@ public function copyrightYear($copyrightYear) return $this->setProperty('copyrightYear', $copyrightYear); } + /** + * Countries for which the application is not supported. You can also + * provide the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesNotSupported + * + * @return static + * + * @see http://schema.org/countriesNotSupported + */ + public function countriesNotSupported($countriesNotSupported) + { + return $this->setProperty('countriesNotSupported', $countriesNotSupported); + } + + /** + * Countries for which the application is supported. You can also provide + * the two-letter ISO 3166-1 alpha-2 country code. + * + * @param string|string[] $countriesSupported + * + * @return static + * + * @see http://schema.org/countriesSupported + */ + public function countriesSupported($countriesSupported) + { + return $this->setProperty('countriesSupported', $countriesSupported); + } + /** * The creator/author of this CreativeWork. This is the same as the Author * property for CreativeWork. @@ -830,6 +600,52 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * Device required to run the application. Used in cases where a specific + * make/model is required to run the application. + * + * @param string|string[] $device + * + * @return static + * + * @see http://schema.org/device + */ + public function device($device) + { + return $this->setProperty('device', $device); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -844,6 +660,20 @@ public function discussionUrl($discussionUrl) return $this->setProperty('discussionUrl', $discussionUrl); } + /** + * If the file can be downloaded, URL to download the binary. + * + * @param string|string[] $downloadUrl + * + * @return static + * + * @see http://schema.org/downloadUrl + */ + public function downloadUrl($downloadUrl) + { + return $this->setProperty('downloadUrl', $downloadUrl); + } + /** * Specifies the Person who edited the CreativeWork. * @@ -976,6 +806,21 @@ public function expires($expires) return $this->setProperty('expires', $expires); } + /** + * Features or modules provided by this application (and possibly required + * by other applications). + * + * @param string|string[] $featureList + * + * @return static + * + * @see http://schema.org/featureList + */ + public function featureList($featureList) + { + return $this->setProperty('featureList', $featureList); + } + /** * Media type, typically MIME format (see [IANA * site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of @@ -997,6 +842,21 @@ public function fileFormat($fileFormat) return $this->setProperty('fileFormat', $fileFormat); } + /** + * Size of the application / package (e.g. 18MB). In the absence of a unit + * (MB, KB etc.), KB will be assumed. + * + * @param string|string[] $fileSize + * + * @return static + * + * @see http://schema.org/fileSize + */ + public function fileSize($fileSize) + { + return $this->setProperty('fileSize', $fileSize); + } + /** * A person or organization that supports (sponsors) something through some * kind of financial contribution. @@ -1034,25 +894,58 @@ public function genre($genre) * * @return static * - * @see http://schema.org/hasPart + * @see http://schema.org/hasPart + */ + public function hasPart($hasPart) + { + return $this->setProperty('hasPart', $hasPart); + } + + /** + * Headline of the article. + * + * @param string|string[] $headline + * + * @return static + * + * @see http://schema.org/headline + */ + public function headline($headline) + { + return $this->setProperty('headline', $headline); + } + + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier */ - public function hasPart($hasPart) + public function identifier($identifier) { - return $this->setProperty('hasPart', $hasPart); + return $this->setProperty('identifier', $identifier); } /** - * Headline of the article. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param string|string[] $headline + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/headline + * @see http://schema.org/image */ - public function headline($headline) + public function image($image) { - return $this->setProperty('headline', $headline); + return $this->setProperty('image', $image); } /** @@ -1072,6 +965,21 @@ public function inLanguage($inLanguage) return $this->setProperty('inLanguage', $inLanguage); } + /** + * URL at which the app may be installed, if different from the URL of the + * item. + * + * @param string|string[] $installUrl + * + * @return static + * + * @see http://schema.org/installUrl + */ + public function installUrl($installUrl) + { + return $this->setProperty('installUrl', $installUrl); + } + /** * The number of interactions for the CreativeWork using the WebSite or * SoftwareApplication. The most specific child type of InteractionCounter @@ -1252,6 +1160,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1267,6 +1191,20 @@ public function material($material) return $this->setProperty('material', $material); } + /** + * Minimum memory requirements. + * + * @param string|string[] $memoryRequirements + * + * @return static + * + * @see http://schema.org/memoryRequirements + */ + public function memoryRequirements($memoryRequirements) + { + return $this->setProperty('memoryRequirements', $memoryRequirements); + } + /** * Indicates that the CreativeWork contains a reference to, but is not * necessarily about a concept. @@ -1282,6 +1220,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1298,6 +1250,35 @@ public function offers($offers) return $this->setProperty('offers', $offers); } + /** + * Operating systems supported (Windows 7, OSX 10.6, Android 1.6). + * + * @param string|string[] $operatingSystem + * + * @return static + * + * @see http://schema.org/operatingSystem + */ + public function operatingSystem($operatingSystem) + { + return $this->setProperty('operatingSystem', $operatingSystem); + } + + /** + * Permission(s) required to run the app (for example, a mobile app may + * require full internet access or may run only on wifi). + * + * @param string|string[] $permissions + * + * @return static + * + * @see http://schema.org/permissions + */ + public function permissions($permissions) + { + return $this->setProperty('permissions', $permissions); + } + /** * The position of an item in a series or sequence of items. * @@ -1312,6 +1293,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Processor architecture required to run the application (e.g. IA64). + * + * @param string|string[] $processorRequirements + * + * @return static + * + * @see http://schema.org/processorRequirements + */ + public function processorRequirements($processorRequirements) + { + return $this->setProperty('processorRequirements', $processorRequirements); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1410,6 +1420,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * Description of what changed in this version. + * + * @param string|string[] $releaseNotes + * + * @return static + * + * @see http://schema.org/releaseNotes + */ + public function releaseNotes($releaseNotes) + { + return $this->setProperty('releaseNotes', $releaseNotes); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1425,6 +1449,23 @@ public function releasedEvent($releasedEvent) return $this->setProperty('releasedEvent', $releasedEvent); } + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $requirements + * + * @return static + * + * @see http://schema.org/requirements + */ + public function requirements($requirements) + { + return $this->setProperty('requirements', $requirements); + } + /** * A review of the item. * @@ -1454,20 +1495,109 @@ public function reviews($reviews) } /** - * Indicates (by URL or string) a particular version of a schema used in - * some CreativeWork. For example, a document could declare a schemaVersion - * using an URL such as http://schema.org/version/2.0/ if precise indication - * of schema version was required by some application. + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + + /** + * Indicates (by URL or string) a particular version of a schema used in + * some CreativeWork. For example, a document could declare a schemaVersion + * using an URL such as http://schema.org/version/2.0/ if precise indication + * of schema version was required by some application. + * + * @param string|string[] $schemaVersion + * + * @return static + * + * @see http://schema.org/schemaVersion + */ + public function schemaVersion($schemaVersion) + { + return $this->setProperty('schemaVersion', $schemaVersion); + } + + /** + * A link to a screenshot image of the app. + * + * @param ImageObject|ImageObject[]|string|string[] $screenshot + * + * @return static + * + * @see http://schema.org/screenshot + */ + public function screenshot($screenshot) + { + return $this->setProperty('screenshot', $screenshot); + } + + /** + * Additional content for a software application. + * + * @param SoftwareApplication|SoftwareApplication[] $softwareAddOn + * + * @return static + * + * @see http://schema.org/softwareAddOn + */ + public function softwareAddOn($softwareAddOn) + { + return $this->setProperty('softwareAddOn', $softwareAddOn); + } + + /** + * Software application help. + * + * @param CreativeWork|CreativeWork[] $softwareHelp + * + * @return static + * + * @see http://schema.org/softwareHelp + */ + public function softwareHelp($softwareHelp) + { + return $this->setProperty('softwareHelp', $softwareHelp); + } + + /** + * Component dependency requirements for application. This includes runtime + * environments and shared libraries that are not included in the + * application distribution package, but required to run the application + * (Examples: DirectX, Java or .NET runtime). + * + * @param string|string[] $softwareRequirements + * + * @return static + * + * @see http://schema.org/softwareRequirements + */ + public function softwareRequirements($softwareRequirements) + { + return $this->setProperty('softwareRequirements', $softwareRequirements); + } + + /** + * Version of the software instance. * - * @param string|string[] $schemaVersion + * @param string|string[] $softwareVersion * * @return static * - * @see http://schema.org/schemaVersion + * @see http://schema.org/softwareVersion */ - public function schemaVersion($schemaVersion) + public function softwareVersion($softwareVersion) { - return $this->setProperty('schemaVersion', $schemaVersion); + return $this->setProperty('softwareVersion', $softwareVersion); } /** @@ -1535,6 +1665,48 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * Storage requirements (free space required). + * + * @param string|string[] $storageRequirements + * + * @return static + * + * @see http://schema.org/storageRequirements + */ + public function storageRequirements($storageRequirements) + { + return $this->setProperty('storageRequirements', $storageRequirements); + } + + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + + /** + * Supporting data for a SoftwareApplication. + * + * @param DataFeed|DataFeed[] $supportingData + * + * @return static + * + * @see http://schema.org/supportingData + */ + public function supportingData($supportingData) + { + return $this->setProperty('supportingData', $supportingData); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1656,6 +1828,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1699,190 +1885,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/WebPage.php b/src/WebPage.php index 33bd00288..f02e1562b 100644 --- a/src/WebPage.php +++ b/src/WebPage.php @@ -17,176 +17,6 @@ */ class WebPage extends BaseType implements CreativeWorkContract, ThingContract { - /** - * A set of links that can help a user understand and navigate a website - * hierarchy. - * - * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb - * - * @return static - * - * @see http://schema.org/breadcrumb - */ - public function breadcrumb($breadcrumb) - { - return $this->setProperty('breadcrumb', $breadcrumb); - } - - /** - * Date on which the content on this web page was last reviewed for accuracy - * and/or completeness. - * - * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed - * - * @return static - * - * @see http://schema.org/lastReviewed - */ - public function lastReviewed($lastReviewed) - { - return $this->setProperty('lastReviewed', $lastReviewed); - } - - /** - * Indicates if this web page element is the main subject of the page. - * - * @param WebPageElement|WebPageElement[] $mainContentOfPage - * - * @return static - * - * @see http://schema.org/mainContentOfPage - */ - public function mainContentOfPage($mainContentOfPage) - { - return $this->setProperty('mainContentOfPage', $mainContentOfPage); - } - - /** - * Indicates the main image on the page. - * - * @param ImageObject|ImageObject[] $primaryImageOfPage - * - * @return static - * - * @see http://schema.org/primaryImageOfPage - */ - public function primaryImageOfPage($primaryImageOfPage) - { - return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); - } - - /** - * A link related to this web page, for example to other related web pages. - * - * @param string|string[] $relatedLink - * - * @return static - * - * @see http://schema.org/relatedLink - */ - public function relatedLink($relatedLink) - { - return $this->setProperty('relatedLink', $relatedLink); - } - - /** - * People or organizations that have reviewed the content on this web page - * for accuracy and/or completeness. - * - * @param Organization|Organization[]|Person|Person[] $reviewedBy - * - * @return static - * - * @see http://schema.org/reviewedBy - */ - public function reviewedBy($reviewedBy) - { - return $this->setProperty('reviewedBy', $reviewedBy); - } - - /** - * One of the more significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLink - * - * @return static - * - * @see http://schema.org/significantLink - */ - public function significantLink($significantLink) - { - return $this->setProperty('significantLink', $significantLink); - } - - /** - * The most significant URLs on the page. Typically, these are the - * non-navigation links that are clicked on the most. - * - * @param string|string[] $significantLinks - * - * @return static - * - * @see http://schema.org/significantLinks - */ - public function significantLinks($significantLinks) - { - return $this->setProperty('significantLinks', $significantLinks); - } - - /** - * Indicates sections of a Web page that are particularly 'speakable' in the - * sense of being highlighted as being especially appropriate for - * text-to-speech conversion. Other sections of a page may also be usefully - * spoken in particular circumstances; the 'speakable' property serves to - * indicate the parts most likely to be generally useful for speech. - * - * The *speakable* property can be repeated an arbitrary number of times, - * with three kinds of possible 'content-locator' values: - * - * 1.) *id-value* URL references - uses *id-value* of an element in the page - * being annotated. The simplest use of *speakable* has (potentially - * relative) URL values, referencing identified sections of the document - * concerned. - * - * 2.) CSS Selectors - addresses content in the annotated page, eg. via - * class attribute. Use the [[cssSelector]] property. - * - * 3.) XPaths - addresses content via XPaths (assuming an XML view of the - * content). Use the [[xpath]] property. - * - * - * For more sophisticated markup of speakable sections beyond simple ID - * references, either CSS selectors or XPath expressions to pick out - * document section(s) as speakable. For this - * we define a supporting type, [[SpeakableSpecification]] which is defined - * to be a possible value of the *speakable* property. - * - * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable - * - * @return static - * - * @see http://schema.org/speakable - */ - public function speakable($speakable) - { - return $this->setProperty('speakable', $speakable); - } - - /** - * One of the domain specialities to which this web page's content applies. - * - * @param Specialty|Specialty[] $specialty - * - * @return static - * - * @see http://schema.org/specialty - */ - public function specialty($specialty) - { - return $this->setProperty('specialty', $specialty); - } - /** * The subject matter of the content. * @@ -331,6 +161,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -346,6 +195,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -447,6 +310,21 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A set of links that can help a user understand and navigate a website + * hierarchy. + * + * @param BreadcrumbList|BreadcrumbList[]|string|string[] $breadcrumb + * + * @return static + * + * @see http://schema.org/breadcrumb + */ + public function breadcrumb($breadcrumb) + { + return $this->setProperty('breadcrumb', $breadcrumb); + } + /** * Fictional person connected with a creative work. * @@ -637,6 +515,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -863,13 +772,46 @@ public function headline($headline) } /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. + * + * @param Language|Language[]|string|string[] $inLanguage + * * @return static * * @see http://schema.org/inLanguage @@ -999,6 +941,21 @@ public function keywords($keywords) return $this->setProperty('keywords', $keywords); } + /** + * Date on which the content on this web page was last reviewed for accuracy + * and/or completeness. + * + * @param \DateTimeInterface|\DateTimeInterface[] $lastReviewed + * + * @return static + * + * @see http://schema.org/lastReviewed + */ + public function lastReviewed($lastReviewed) + { + return $this->setProperty('lastReviewed', $lastReviewed); + } + /** * The predominant type or kind characterizing the learning resource. For * example, 'presentation', 'handout'. @@ -1044,6 +1001,20 @@ public function locationCreated($locationCreated) return $this->setProperty('locationCreated', $locationCreated); } + /** + * Indicates if this web page element is the main subject of the page. + * + * @param WebPageElement|WebPageElement[] $mainContentOfPage + * + * @return static + * + * @see http://schema.org/mainContentOfPage + */ + public function mainContentOfPage($mainContentOfPage) + { + return $this->setProperty('mainContentOfPage', $mainContentOfPage); + } + /** * Indicates the primary entity described in some page or other * CreativeWork. @@ -1059,6 +1030,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -1089,6 +1076,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -1119,6 +1120,35 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + + /** + * Indicates the main image on the page. + * + * @param ImageObject|ImageObject[] $primaryImageOfPage + * + * @return static + * + * @see http://schema.org/primaryImageOfPage + */ + public function primaryImageOfPage($primaryImageOfPage) + { + return $this->setProperty('primaryImageOfPage', $primaryImageOfPage); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1217,6 +1247,20 @@ public function recordedAt($recordedAt) return $this->setProperty('recordedAt', $recordedAt); } + /** + * A link related to this web page, for example to other related web pages. + * + * @param string|string[] $relatedLink + * + * @return static + * + * @see http://schema.org/relatedLink + */ + public function relatedLink($relatedLink) + { + return $this->setProperty('relatedLink', $relatedLink); + } + /** * The place and time the release was issued, expressed as a * PublicationEvent. @@ -1246,6 +1290,21 @@ public function review($review) return $this->setProperty('review', $review); } + /** + * People or organizations that have reviewed the content on this web page + * for accuracy and/or completeness. + * + * @param Organization|Organization[]|Person|Person[] $reviewedBy + * + * @return static + * + * @see http://schema.org/reviewedBy + */ + public function reviewedBy($reviewedBy) + { + return $this->setProperty('reviewedBy', $reviewedBy); + } + /** * Review of the item. * @@ -1260,6 +1319,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1277,6 +1352,36 @@ public function schemaVersion($schemaVersion) return $this->setProperty('schemaVersion', $schemaVersion); } + /** + * One of the more significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLink + * + * @return static + * + * @see http://schema.org/significantLink + */ + public function significantLink($significantLink) + { + return $this->setProperty('significantLink', $significantLink); + } + + /** + * The most significant URLs on the page. Typically, these are the + * non-navigation links that are clicked on the most. + * + * @param string|string[] $significantLinks + * + * @return static + * + * @see http://schema.org/significantLinks + */ + public function significantLinks($significantLinks) + { + return $this->setProperty('significantLinks', $significantLinks); + } + /** * The Organization on whose behalf the creator was working. * @@ -1326,6 +1431,59 @@ public function spatialCoverage($spatialCoverage) return $this->setProperty('spatialCoverage', $spatialCoverage); } + /** + * Indicates sections of a Web page that are particularly 'speakable' in the + * sense of being highlighted as being especially appropriate for + * text-to-speech conversion. Other sections of a page may also be usefully + * spoken in particular circumstances; the 'speakable' property serves to + * indicate the parts most likely to be generally useful for speech. + * + * The *speakable* property can be repeated an arbitrary number of times, + * with three kinds of possible 'content-locator' values: + * + * 1.) *id-value* URL references - uses *id-value* of an element in the page + * being annotated. The simplest use of *speakable* has (potentially + * relative) URL values, referencing identified sections of the document + * concerned. + * + * 2.) CSS Selectors - addresses content in the annotated page, eg. via + * class attribute. Use the [[cssSelector]] property. + * + * 3.) XPaths - addresses content via XPaths (assuming an XML view of the + * content). Use the [[xpath]] property. + * + * + * For more sophisticated markup of speakable sections beyond simple ID + * references, either CSS selectors or XPath expressions to pick out + * document section(s) as speakable. For this + * we define a supporting type, [[SpeakableSpecification]] which is defined + * to be a possible value of the *speakable* property. + * + * @param SpeakableSpecification|SpeakableSpecification[]|string|string[] $speakable + * + * @return static + * + * @see http://schema.org/speakable + */ + public function speakable($speakable) + { + return $this->setProperty('speakable', $speakable); + } + + /** + * One of the domain specialities to which this web page's content applies. + * + * @param Specialty|Specialty[] $specialty + * + * @return static + * + * @see http://schema.org/specialty + */ + public function specialty($specialty) + { + return $this->setProperty('specialty', $specialty); + } + /** * 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 @@ -1342,6 +1500,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1463,6 +1635,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1506,190 +1692,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/WebPageElement.php b/src/WebPageElement.php index 124b418b3..a822c2260 100644 --- a/src/WebPageElement.php +++ b/src/WebPageElement.php @@ -159,6 +159,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -174,6 +193,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -465,6 +498,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -690,6 +754,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -887,6 +984,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -917,6 +1030,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -947,6 +1074,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1088,6 +1230,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1170,6 +1328,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1291,6 +1463,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1334,190 +1520,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/WebSite.php b/src/WebSite.php index 905c4ed10..20c67a927 100644 --- a/src/WebSite.php +++ b/src/WebSite.php @@ -14,22 +14,6 @@ */ class WebSite extends BaseType implements CreativeWorkContract, ThingContract { - /** - * The International Standard Serial Number (ISSN) that identifies this - * serial publication. You can repeat this property to identify different - * formats of, or the linking ISSN (ISSN-L) for, this serial publication. - * - * @param string|string[] $issn - * - * @return static - * - * @see http://schema.org/issn - */ - public function issn($issn) - { - return $this->setProperty('issn', $issn); - } - /** * The subject matter of the content. * @@ -174,6 +158,25 @@ public function accountablePerson($accountablePerson) return $this->setProperty('accountablePerson', $accountablePerson); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * The overall rating, based on a collection of reviews or ratings, of the * item. @@ -189,6 +192,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * A secondary title of the CreativeWork. * @@ -480,6 +497,37 @@ public function datePublished($datePublished) return $this->setProperty('datePublished', $datePublished); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * A link to the page containing the comments of the CreativeWork. * @@ -705,6 +753,39 @@ public function headline($headline) return $this->setProperty('headline', $headline); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The language of the content or performance or used in an action. Please * use one of the language codes from the [IETF BCP 47 @@ -827,6 +908,22 @@ public function isPartOf($isPartOf) return $this->setProperty('isPartOf', $isPartOf); } + /** + * The International Standard Serial Number (ISSN) that identifies this + * serial publication. You can repeat this property to identify different + * formats of, or the linking ISSN (ISSN-L) for, this serial publication. + * + * @param string|string[] $issn + * + * @return static + * + * @see http://schema.org/issn + */ + public function issn($issn) + { + return $this->setProperty('issn', $issn); + } + /** * Keywords or tags used to describe this content. Multiple entries in a * keywords list are typically delimited by commas. @@ -902,6 +999,22 @@ public function mainEntity($mainEntity) return $this->setProperty('mainEntity', $mainEntity); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A material that something is made from, e.g. leather, wool, cotton, * paper. @@ -932,6 +1045,20 @@ public function mentions($mentions) return $this->setProperty('mentions', $mentions); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * An offer to provide this item—for example, an offer to sell a * product, rent the DVD of a movie, perform a service, or give away tickets @@ -962,6 +1089,21 @@ public function position($position) return $this->setProperty('position', $position); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The person or organization who produced the work (e.g. music album, * movie, tv/radio series etc.). @@ -1103,6 +1245,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * Indicates (by URL or string) a particular version of a schema used in * some CreativeWork. For example, a document could declare a schemaVersion @@ -1185,6 +1343,20 @@ public function sponsor($sponsor) return $this->setProperty('sponsor', $sponsor); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The "temporal" property can be used in cases where more specific * properties @@ -1306,6 +1478,20 @@ public function typicalAgeRange($typicalAgeRange) return $this->setProperty('typicalAgeRange', $typicalAgeRange); } + /** + * URL of the item. + * + * @param string|string[] $url + * + * @return static + * + * @see http://schema.org/url + */ + public function url($url) + { + return $this->setProperty('url', $url); + } + /** * The version of the CreativeWork embodied by a specified resource. * @@ -1349,190 +1535,4 @@ public function workExample($workExample) return $this->setProperty('workExample', $workExample); } - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - } diff --git a/src/WholesaleStore.php b/src/WholesaleStore.php index af0e15922..d60c7cea3 100644 --- a/src/WholesaleStore.php +++ b/src/WholesaleStore.php @@ -17,126 +17,104 @@ class WholesaleStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. - * - * @param Organization|Organization[] $branchOf - * - * @return static - * - * @see http://schema.org/branchOf - */ - public function branchOf($branchOf) - { - return $this->setProperty('branchOf', $branchOf); - } - - /** - * The currency accepted. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param string|string[] $currenciesAccepted + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/additionalProperty */ - public function currenciesAccepted($currenciesAccepted) + public function additionalProperty($additionalProperty) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param string|string[] $openingHours + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/additionalType */ - public function openingHours($openingHours) + public function additionalType($additionalType) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('additionalType', $additionalType); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * Physical address of the item. * - * @param string|string[] $paymentAccepted + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/address */ - public function paymentAccepted($paymentAccepted) + public function address($address) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('address', $address); } /** - * The price range of the business, for example ```$$$```. + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param string|string[] $priceRange + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/aggregateRating */ - public function priceRange($priceRange) + public function aggregateRating($aggregateRating) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * Physical address of the item. + * An alias for the item. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/address + * @see http://schema.org/alternateName */ - public function address($address) + public function alternateName($alternateName) { - return $this->setProperty('address', $address); + return $this->setProperty('alternateName', $alternateName); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/amenityFeature */ - public function aggregateRating($aggregateRating) + public function amenityFeature($amenityFeature) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('amenityFeature', $amenityFeature); } /** @@ -181,6 +159,41 @@ public function awards($awards) return $this->setProperty('awards', $awards); } + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. 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. + * + * @param string|string[] $branchCode + * + * @return static + * + * @see http://schema.org/branchCode + */ + public function branchCode($branchCode) + { + return $this->setProperty('branchCode', $branchCode); + } + + /** + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. + * + * @param Organization|Organization[] $branchOf + * + * @return static + * + * @see http://schema.org/branchOf + */ + public function branchOf($branchOf) + { + return $this->setProperty('branchOf', $branchOf); + } + /** * The brand(s) associated with a product or service, or the brand(s) * maintained by an organization or business person. @@ -224,6 +237,71 @@ public function contactPoints($contactPoints) return $this->setProperty('contactPoints', $contactPoints); } + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedIn + * + * @return static + * + * @see http://schema.org/containedIn + */ + public function containedIn($containedIn) + { + return $this->setProperty('containedIn', $containedIn); + } + + /** + * The basic containment relation between a place and one that contains it. + * + * @param Place|Place[] $containedInPlace + * + * @return static + * + * @see http://schema.org/containedInPlace + */ + public function containedInPlace($containedInPlace) + { + return $this->setProperty('containedInPlace', $containedInPlace); + } + + /** + * The basic containment relation between a place and another that it + * contains. + * + * @param Place|Place[] $containsPlace + * + * @return static + * + * @see http://schema.org/containsPlace + */ + public function containsPlace($containsPlace) + { + return $this->setProperty('containsPlace', $containsPlace); + } + + /** + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". + * + * @param string|string[] $currenciesAccepted + * + * @return static + * + * @see http://schema.org/currenciesAccepted + */ + public function currenciesAccepted($currenciesAccepted) + { + return $this->setProperty('currenciesAccepted', $currenciesAccepted); + } + /** * A relationship between an organization and a department of that * organization, also described as an organization (allowing different urls, @@ -241,6 +319,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -427,22 +536,50 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. + * The geo coordinates of the place. * - * @param string|string[] $globalLocationNumber + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/globalLocationNumber + * @see http://schema.org/geo */ - public function globalLocationNumber($globalLocationNumber) + public function geo($geo) + { + return $this->setProperty('geo', $geo); + } + + /** + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. + * + * @param string|string[] $globalLocationNumber + * + * @return static + * + * @see http://schema.org/globalLocationNumber + */ + public function globalLocationNumber($globalLocationNumber) { return $this->setProperty('globalLocationNumber', $globalLocationNumber); } + /** + * A URL to a map of the place. + * + * @param Map|Map[]|string|string[] $hasMap + * + * @return static + * + * @see http://schema.org/hasMap + */ + public function hasMap($hasMap) + { + return $this->setProperty('hasMap', $hasMap); + } + /** * Indicates an OfferCatalog listing for this Organization, Person, or * Service. @@ -472,6 +609,53 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + + /** + * A flag to signal that the item, event, or place is accessible for free. + * + * @param bool|bool[] $isAccessibleForFree + * + * @return static + * + * @see http://schema.org/isAccessibleForFree + */ + public function isAccessibleForFree($isAccessibleForFree) + { + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -488,6 +672,21 @@ public function isicV4($isicV4) return $this->setProperty('isicV4', $isicV4); } + /** + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $latitude + * + * @return static + * + * @see http://schema.org/latitude + */ + public function latitude($latitude) + { + return $this->setProperty('latitude', $latitude); + } + /** * The official name of the organization, e.g. the registered company name. * @@ -546,6 +745,37 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * + * @param float|float[]|int|int[]|string|string[] $longitude + * + * @return static + * + * @see http://schema.org/longitude + */ + public function longitude($longitude) + { + return $this->setProperty('longitude', $longitude); + } + + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -560,6 +790,48 @@ public function makesOffer($makesOffer) return $this->setProperty('makesOffer', $makesOffer); } + /** + * A URL to a map of the place. + * + * @param string|string[] $map + * + * @return static + * + * @see http://schema.org/map + */ + public function map($map) + { + return $this->setProperty('map', $map); + } + + /** + * A URL to a map of the place. + * + * @param string|string[] $maps + * + * @return static + * + * @see http://schema.org/maps + */ + public function maps($maps) + { + return $this->setProperty('maps', $maps); + } + + /** + * The total number of individuals that may attend an event or venue. + * + * @param int|int[] $maximumAttendeeCapacity + * + * @return static + * + * @see http://schema.org/maximumAttendeeCapacity + */ + public function maximumAttendeeCapacity($maximumAttendeeCapacity) + { + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + } + /** * A member of an Organization or a ProgramMembership. Organizations can be * members of organizations; ProgramMembership is typically for individuals. @@ -619,6 +891,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -647,6 +933,49 @@ public function offeredBy($offeredBy) return $this->setProperty('offeredBy', $offeredBy); } + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + + /** + * The opening hours of a certain place. + * + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * + * @return static + * + * @see http://schema.org/openingHoursSpecification + */ + public function openingHoursSpecification($openingHoursSpecification) + { + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + } + /** * Products owned by the organization or person. * @@ -677,664 +1006,335 @@ public function parentOrganization($parentOrganization) } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/paymentAccepted */ - public function publishingPrinciples($publishingPrinciples) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * A review of the item. + * A photograph of this place. * - * @param Review|Review[] $review + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/review + * @see http://schema.org/photo */ - public function review($review) + public function photo($photo) { - return $this->setProperty('review', $review); + return $this->setProperty('photo', $photo); } /** - * Review of the item. + * Photographs of this place. * - * @param Review|Review[] $reviews - * - * @return static - * - * @see http://schema.org/reviews - */ - public function reviews($reviews) - { - return $this->setProperty('reviews', $reviews); - } - - /** - * A pointer to products or services sought by the organization or person - * (demand). - * - * @param Demand|Demand[] $seeks - * - * @return static - * - * @see http://schema.org/seeks - */ - public function seeks($seeks) - { - return $this->setProperty('seeks', $seeks); - } - - /** - * The geographic area where the service is provided. - * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea - * - * @return static - * - * @see http://schema.org/serviceArea - */ - public function serviceArea($serviceArea) - { - return $this->setProperty('serviceArea', $serviceArea); - } - - /** - * A slogan or motto associated with the item. - * - * @param string|string[] $slogan - * - * @return static - * - * @see http://schema.org/slogan - */ - public function slogan($slogan) - { - return $this->setProperty('slogan', $slogan); - } - - /** - * 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. - * - * @param Organization|Organization[]|Person|Person[] $sponsor - * - * @return static - * - * @see http://schema.org/sponsor - */ - public function sponsor($sponsor) - { - return $this->setProperty('sponsor', $sponsor); - } - - /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. - * - * @param Organization|Organization[] $subOrganization - * - * @return static - * - * @see http://schema.org/subOrganization - */ - public function subOrganization($subOrganization) - { - return $this->setProperty('subOrganization', $subOrganization); - } - - /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. - * - * @param string|string[] $taxID - * - * @return static - * - * @see http://schema.org/taxID - */ - public function taxID($taxID) - { - return $this->setProperty('taxID', $taxID); - } - - /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. - * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf - * - * @return static - * - * @see http://schema.org/subjectOf - */ - public function subjectOf($subjectOf) - { - return $this->setProperty('subjectOf', $subjectOf); - } - - /** - * URL of the item. - * - * @param string|string[] $url - * - * @return static - * - * @see http://schema.org/url - */ - public function url($url) - { - return $this->setProperty('url', $url); - } - - /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. - * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/photos */ - public function additionalProperty($additionalProperty) + public function photos($photos) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('photos', $photos); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/potentialAction */ - public function amenityFeature($amenityFeature) + public function potentialAction($potentialAction) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. 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. + * The price range of the business, for example ```$$$```. * - * @param string|string[] $branchCode + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/priceRange */ - public function branchCode($branchCode) + public function priceRange($priceRange) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('priceRange', $priceRange); } /** - * The basic containment relation between a place and one that contains it. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param Place|Place[] $containedIn + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/publicAccess */ - public function containedIn($containedIn) + public function publicAccess($publicAccess) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('publicAccess', $publicAccess); } /** - * The basic containment relation between a place and one that contains it. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. + * + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param Place|Place[] $containedInPlace + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/publishingPrinciples */ - public function containedInPlace($containedInPlace) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and another that it - * contains. + * A review of the item. * - * @param Place|Place[] $containsPlace + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/review */ - public function containsPlace($containsPlace) + public function review($review) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('review', $review); } /** - * The geo coordinates of the place. + * Review of the item. * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/reviews */ - public function geo($geo) + public function reviews($reviews) { - return $this->setProperty('geo', $geo); + return $this->setProperty('reviews', $reviews); } /** - * A URL to a map of the place. + * 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. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/sameAs */ - public function hasMap($hasMap) + public function sameAs($sameAs) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('sameAs', $sameAs); } /** - * A flag to signal that the item, event, or place is accessible for free. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param bool|bool[] $isAccessibleForFree + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/seeks */ - public function isAccessibleForFree($isAccessibleForFree) + public function seeks($seeks) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('seeks', $seeks); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * The geographic area where the service is provided. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/serviceArea */ - public function latitude($latitude) + public function serviceArea($serviceArea) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/slogan */ - public function longitude($longitude) + public function slogan($slogan) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('slogan', $slogan); } /** - * A URL to a map of the place. + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param string|string[] $map + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/map + * @see http://schema.org/smokingAllowed */ - public function map($map) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('map', $map); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $maps + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/specialOpeningHoursSpecification */ - public function maps($maps) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('maps', $maps); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * The total number of individuals that may attend an event or venue. + * 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. * - * @param int|int[] $maximumAttendeeCapacity + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/sponsor */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function sponsor($sponsor) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('sponsor', $sponsor); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/WinAction.php b/src/WinAction.php index 0532cf2e0..b5356dc93 100644 --- a/src/WinAction.php +++ b/src/WinAction.php @@ -15,31 +15,36 @@ class WinAction extends BaseType implements AchieveActionContract, ActionContract, ThingContract { /** - * A sub property of participant. The loser of the action. + * Indicates the current disposition of the Action. * - * @param Person|Person[] $loser + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/loser + * @see http://schema.org/actionStatus */ - public function loser($loser) + public function actionStatus($actionStatus) { - return $this->setProperty('loser', $loser); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -58,325 +63,320 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/instrument */ - public function startTime($startTime) + public function instrument($instrument) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('instrument', $instrument); } /** - * Indicates a target EntryPoint for an Action. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param EntryPoint|EntryPoint[] $target + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/target + * @see http://schema.org/location */ - public function target($target) + public function location($location) { - return $this->setProperty('target', $target); + return $this->setProperty('location', $location); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * A sub property of participant. The loser of the action. * - * @param string|string[] $additionalType + * @param Person|Person[] $loser * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/loser */ - public function additionalType($additionalType) + public function loser($loser) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('loser', $loser); } /** - * An alias for the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $alternateName + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/mainEntityOfPage */ - public function alternateName($alternateName) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A description of the item. + * The name of the item. * - * @param string|string[] $description + * @param string|string[] $name * * @return static * - * @see http://schema.org/description + * @see http://schema.org/name */ - public function description($description) + public function name($name) { - return $this->setProperty('description', $description); + return $this->setProperty('name', $name); } /** - * 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. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param string|string[] $disambiguatingDescription + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/object */ - public function disambiguatingDescription($disambiguatingDescription) + public function object($object) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('object', $object); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/participant */ - public function identifier($identifier) + public function participant($participant) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('participant', $participant); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/image + * @see http://schema.org/potentialAction */ - public function image($image) + public function potentialAction($potentialAction) { - return $this->setProperty('image', $image); + return $this->setProperty('potentialAction', $potentialAction); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * The result produced in the action. e.g. John wrote *a book*. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/result */ - public function mainEntityOfPage($mainEntityOfPage) + public function result($result) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('result', $result); } /** - * The name of the item. + * 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. * - * @param string|string[] $name + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/name + * @see http://schema.org/sameAs */ - public function name($name) + public function sameAs($sameAs) { - return $this->setProperty('name', $name); + return $this->setProperty('sameAs', $sameAs); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Action|Action[] $potentialAction + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/startTime */ - public function potentialAction($potentialAction) + public function startTime($startTime) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('startTime', $startTime); } /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * Indicates a target EntryPoint for an Action. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param EntryPoint|EntryPoint[] $target * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/target */ - public function subjectOf($subjectOf) + public function target($target) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('target', $target); } /** diff --git a/src/Winery.php b/src/Winery.php index 4d89a9e87..83f0f778f 100644 --- a/src/Winery.php +++ b/src/Winery.php @@ -33,289 +33,337 @@ public function acceptsReservations($acceptsReservations) } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * A property-value pair representing an additional characteristics of the + * entitity, e.g. a product feature or another characteristic for which + * there is no matching property in schema.org. + * + * Note: Publishers should be aware that applications designed to use + * specific schema.org properties (e.g. http://schema.org/width, + * http://schema.org/color, http://schema.org/gtin13, ...) will typically + * expect such data to be provided using those properties, rather than using + * the generic property/value mechanism. * - * @param Menu|Menu[]|string|string[] $hasMenu + * @param PropertyValue|PropertyValue[] $additionalProperty * * @return static * - * @see http://schema.org/hasMenu + * @see http://schema.org/additionalProperty */ - public function hasMenu($hasMenu) + public function additionalProperty($additionalProperty) { - return $this->setProperty('hasMenu', $hasMenu); + return $this->setProperty('additionalProperty', $additionalProperty); } /** - * Either the actual menu as a structured representation, as text, or a URL - * of the menu. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param Menu|Menu[]|string|string[] $menu + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/menu + * @see http://schema.org/additionalType */ - public function menu($menu) + public function additionalType($additionalType) { - return $this->setProperty('menu', $menu); + return $this->setProperty('additionalType', $additionalType); } /** - * The cuisine of the restaurant. + * Physical address of the item. * - * @param string|string[] $servesCuisine + * @param PostalAddress|PostalAddress[]|string|string[] $address * * @return static * - * @see http://schema.org/servesCuisine + * @see http://schema.org/address */ - public function servesCuisine($servesCuisine) + public function address($address) { - return $this->setProperty('servesCuisine', $servesCuisine); + return $this->setProperty('address', $address); } /** - * An official rating for a lodging business or food establishment, e.g. - * from national associations or standards bodies. Use the author property - * to indicate the rating organization, e.g. as an Organization with name - * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). + * The overall rating, based on a collection of reviews or ratings, of the + * item. * - * @param Rating|Rating[] $starRating + * @param AggregateRating|AggregateRating[] $aggregateRating * * @return static * - * @see http://schema.org/starRating + * @see http://schema.org/aggregateRating */ - public function starRating($starRating) + public function aggregateRating($aggregateRating) { - return $this->setProperty('starRating', $starRating); + return $this->setProperty('aggregateRating', $aggregateRating); } /** - * The larger organization that this local business is a branch of, if any. - * Not to be confused with (anatomical)[[branch]]. + * An alias for the item. * - * @param Organization|Organization[] $branchOf + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/branchOf + * @see http://schema.org/alternateName */ - public function branchOf($branchOf) + public function alternateName($alternateName) { - return $this->setProperty('branchOf', $branchOf); + return $this->setProperty('alternateName', $alternateName); } /** - * The currency accepted. - * - * Use standard formats: [ISO 4217 currency - * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker - * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for - * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange - * Tradings - * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) - * (LETS) and other currency types e.g. "Ithaca HOUR". + * An amenity feature (e.g. a characteristic or service) of the + * Accommodation. 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. * - * @param string|string[] $currenciesAccepted + * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature * * @return static * - * @see http://schema.org/currenciesAccepted + * @see http://schema.org/amenityFeature */ - public function currenciesAccepted($currenciesAccepted) + public function amenityFeature($amenityFeature) { - return $this->setProperty('currenciesAccepted', $currenciesAccepted); + return $this->setProperty('amenityFeature', $amenityFeature); } /** - * 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 '-'. + * The geographic area where a service or offered item is provided. + * + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * + * @return static + * + * @see http://schema.org/areaServed + */ + public function areaServed($areaServed) + { + return $this->setProperty('areaServed', $areaServed); + } + + /** + * An award won by or for this item. + * + * @param string|string[] $award + * + * @return static + * + * @see http://schema.org/award + */ + public function award($award) + { + return $this->setProperty('award', $award); + } + + /** + * Awards won by or for this item. + * + * @param string|string[] $awards + * + * @return static + * + * @see http://schema.org/awards + */ + public function awards($awards) + { + return $this->setProperty('awards', $awards); + } + + /** + * A short textual code (also called "store code") that uniquely identifies + * a place of business. The code is typically assigned by the + * parentOrganization and used in structured URLs. * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. + * 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. * - * @param string|string[] $openingHours + * @param string|string[] $branchCode * * @return static * - * @see http://schema.org/openingHours + * @see http://schema.org/branchCode */ - public function openingHours($openingHours) + public function branchCode($branchCode) { - return $this->setProperty('openingHours', $openingHours); + return $this->setProperty('branchCode', $branchCode); } /** - * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. + * The larger organization that this local business is a branch of, if any. + * Not to be confused with (anatomical)[[branch]]. * - * @param string|string[] $paymentAccepted + * @param Organization|Organization[] $branchOf * * @return static * - * @see http://schema.org/paymentAccepted + * @see http://schema.org/branchOf */ - public function paymentAccepted($paymentAccepted) + public function branchOf($branchOf) { - return $this->setProperty('paymentAccepted', $paymentAccepted); + return $this->setProperty('branchOf', $branchOf); } /** - * The price range of the business, for example ```$$$```. + * The brand(s) associated with a product or service, or the brand(s) + * maintained by an organization or business person. * - * @param string|string[] $priceRange + * @param Brand|Brand[]|Organization|Organization[] $brand * * @return static * - * @see http://schema.org/priceRange + * @see http://schema.org/brand */ - public function priceRange($priceRange) + public function brand($brand) { - return $this->setProperty('priceRange', $priceRange); + return $this->setProperty('brand', $brand); } /** - * Physical address of the item. + * A contact point for a person or organization. * - * @param PostalAddress|PostalAddress[]|string|string[] $address + * @param ContactPoint|ContactPoint[] $contactPoint * * @return static * - * @see http://schema.org/address + * @see http://schema.org/contactPoint */ - public function address($address) + public function contactPoint($contactPoint) { - return $this->setProperty('address', $address); + return $this->setProperty('contactPoint', $contactPoint); } /** - * The overall rating, based on a collection of reviews or ratings, of the - * item. + * A contact point for a person or organization. * - * @param AggregateRating|AggregateRating[] $aggregateRating + * @param ContactPoint|ContactPoint[] $contactPoints * * @return static * - * @see http://schema.org/aggregateRating + * @see http://schema.org/contactPoints */ - public function aggregateRating($aggregateRating) + public function contactPoints($contactPoints) { - return $this->setProperty('aggregateRating', $aggregateRating); + return $this->setProperty('contactPoints', $contactPoints); } /** - * The geographic area where a service or offered item is provided. + * The basic containment relation between a place and one that contains it. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[]|string|string[] $areaServed + * @param Place|Place[] $containedIn * * @return static * - * @see http://schema.org/areaServed + * @see http://schema.org/containedIn */ - public function areaServed($areaServed) + public function containedIn($containedIn) { - return $this->setProperty('areaServed', $areaServed); + return $this->setProperty('containedIn', $containedIn); } /** - * An award won by or for this item. + * The basic containment relation between a place and one that contains it. * - * @param string|string[] $award + * @param Place|Place[] $containedInPlace * * @return static * - * @see http://schema.org/award + * @see http://schema.org/containedInPlace */ - public function award($award) + public function containedInPlace($containedInPlace) { - return $this->setProperty('award', $award); + return $this->setProperty('containedInPlace', $containedInPlace); } /** - * Awards won by or for this item. + * The basic containment relation between a place and another that it + * contains. * - * @param string|string[] $awards + * @param Place|Place[] $containsPlace * * @return static * - * @see http://schema.org/awards + * @see http://schema.org/containsPlace */ - public function awards($awards) + public function containsPlace($containsPlace) { - return $this->setProperty('awards', $awards); + return $this->setProperty('containsPlace', $containsPlace); } /** - * The brand(s) associated with a product or service, or the brand(s) - * maintained by an organization or business person. + * The currency accepted. + * + * Use standard formats: [ISO 4217 currency + * format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker + * symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for + * cryptocurrencies e.g. "BTC"; well known names for [Local Exchange + * Tradings + * Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) + * (LETS) and other currency types e.g. "Ithaca HOUR". * - * @param Brand|Brand[]|Organization|Organization[] $brand + * @param string|string[] $currenciesAccepted * * @return static * - * @see http://schema.org/brand + * @see http://schema.org/currenciesAccepted */ - public function brand($brand) + public function currenciesAccepted($currenciesAccepted) { - return $this->setProperty('brand', $brand); + return $this->setProperty('currenciesAccepted', $currenciesAccepted); } /** - * A contact point for a person or organization. + * A relationship between an organization and a department of that + * organization, also described as an organization (allowing different urls, + * logos, opening hours). For example: a store with a pharmacy, or a bakery + * with a cafe. * - * @param ContactPoint|ContactPoint[] $contactPoint + * @param Organization|Organization[] $department * * @return static * - * @see http://schema.org/contactPoint + * @see http://schema.org/department */ - public function contactPoint($contactPoint) + public function department($department) { - return $this->setProperty('contactPoint', $contactPoint); + return $this->setProperty('department', $department); } /** - * A contact point for a person or organization. + * A description of the item. * - * @param ContactPoint|ContactPoint[] $contactPoints + * @param string|string[] $description * * @return static * - * @see http://schema.org/contactPoints + * @see http://schema.org/description */ - public function contactPoints($contactPoints) + public function description($description) { - return $this->setProperty('contactPoints', $contactPoints); + return $this->setProperty('description', $description); } /** - * A relationship between an organization and a department of that - * organization, also described as an organization (allowing different urls, - * logos, opening hours). For example: a store with a pharmacy, or a bakery - * with a cafe. + * 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. * - * @param Organization|Organization[] $department + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/department + * @see http://schema.org/disambiguatingDescription */ - public function department($department) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('department', $department); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** @@ -504,914 +552,866 @@ public function funder($funder) } /** - * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also - * referred to as International Location Number or ILN) of the respective - * organization, person, or place. The GLN is a 13-digit number used to - * identify parties and physical locations. - * - * @param string|string[] $globalLocationNumber - * - * @return static - * - * @see http://schema.org/globalLocationNumber - */ - public function globalLocationNumber($globalLocationNumber) - { - return $this->setProperty('globalLocationNumber', $globalLocationNumber); - } - - /** - * Indicates an OfferCatalog listing for this Organization, Person, or - * Service. - * - * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog - * - * @return static - * - * @see http://schema.org/hasOfferCatalog - */ - public function hasOfferCatalog($hasOfferCatalog) - { - return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); - } - - /** - * Points-of-Sales operated by the organization or person. - * - * @param Place|Place[] $hasPOS - * - * @return static - * - * @see http://schema.org/hasPOS - */ - public function hasPOS($hasPOS) - { - return $this->setProperty('hasPOS', $hasPOS); - } - - /** - * The International Standard of Industrial Classification of All Economic - * Activities (ISIC), Revision 4 code for a particular organization, - * business person, or place. + * The geo coordinates of the place. * - * @param string|string[] $isicV4 + * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo * * @return static * - * @see http://schema.org/isicV4 + * @see http://schema.org/geo */ - public function isicV4($isicV4) + public function geo($geo) { - return $this->setProperty('isicV4', $isicV4); + return $this->setProperty('geo', $geo); } /** - * The official name of the organization, e.g. the registered company name. + * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also + * referred to as International Location Number or ILN) of the respective + * organization, person, or place. The GLN is a 13-digit number used to + * identify parties and physical locations. * - * @param string|string[] $legalName + * @param string|string[] $globalLocationNumber * * @return static * - * @see http://schema.org/legalName + * @see http://schema.org/globalLocationNumber */ - public function legalName($legalName) + public function globalLocationNumber($globalLocationNumber) { - return $this->setProperty('legalName', $legalName); + return $this->setProperty('globalLocationNumber', $globalLocationNumber); } /** - * An organization identifier that uniquely identifies a legal entity as - * defined in ISO 17442. + * A URL to a map of the place. * - * @param string|string[] $leiCode + * @param Map|Map[]|string|string[] $hasMap * * @return static * - * @see http://schema.org/leiCode + * @see http://schema.org/hasMap */ - public function leiCode($leiCode) + public function hasMap($hasMap) { - return $this->setProperty('leiCode', $leiCode); + return $this->setProperty('hasMap', $hasMap); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param Menu|Menu[]|string|string[] $hasMenu * * @return static * - * @see http://schema.org/location + * @see http://schema.org/hasMenu */ - public function location($location) + public function hasMenu($hasMenu) { - return $this->setProperty('location', $location); + return $this->setProperty('hasMenu', $hasMenu); } /** - * An associated logo. + * Indicates an OfferCatalog listing for this Organization, Person, or + * Service. * - * @param ImageObject|ImageObject[]|string|string[] $logo + * @param OfferCatalog|OfferCatalog[] $hasOfferCatalog * * @return static * - * @see http://schema.org/logo + * @see http://schema.org/hasOfferCatalog */ - public function logo($logo) + public function hasOfferCatalog($hasOfferCatalog) { - return $this->setProperty('logo', $logo); + return $this->setProperty('hasOfferCatalog', $hasOfferCatalog); } /** - * A pointer to products or services offered by the organization or person. + * Points-of-Sales operated by the organization or person. * - * @param Offer|Offer[] $makesOffer + * @param Place|Place[] $hasPOS * * @return static * - * @see http://schema.org/makesOffer + * @see http://schema.org/hasPOS */ - public function makesOffer($makesOffer) + public function hasPOS($hasPOS) { - return $this->setProperty('makesOffer', $makesOffer); + return $this->setProperty('hasPOS', $hasPOS); } /** - * A member of an Organization or a ProgramMembership. Organizations can be - * members of organizations; ProgramMembership is typically for individuals. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $member + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/member + * @see http://schema.org/identifier */ - public function member($member) + public function identifier($identifier) { - return $this->setProperty('member', $member); + return $this->setProperty('identifier', $identifier); } /** - * An Organization (or ProgramMembership) to which this Person or - * Organization belongs. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/memberOf + * @see http://schema.org/image */ - public function memberOf($memberOf) + public function image($image) { - return $this->setProperty('memberOf', $memberOf); + return $this->setProperty('image', $image); } /** - * A member of this organization. + * A flag to signal that the item, event, or place is accessible for free. * - * @param Organization|Organization[]|Person|Person[] $members + * @param bool|bool[] $isAccessibleForFree * * @return static * - * @see http://schema.org/members + * @see http://schema.org/isAccessibleForFree */ - public function members($members) + public function isAccessibleForFree($isAccessibleForFree) { - return $this->setProperty('members', $members); + return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); } /** - * The North American Industry Classification System (NAICS) code for a - * particular organization or business person. + * The International Standard of Industrial Classification of All Economic + * Activities (ISIC), Revision 4 code for a particular organization, + * business person, or place. * - * @param string|string[] $naics + * @param string|string[] $isicV4 * * @return static * - * @see http://schema.org/naics + * @see http://schema.org/isicV4 */ - public function naics($naics) + public function isicV4($isicV4) { - return $this->setProperty('naics', $naics); + return $this->setProperty('isicV4', $isicV4); } /** - * The number of employees in an organization e.g. business. + * The latitude of a location. For example ```37.42242``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees + * @param float|float[]|int|int[]|string|string[] $latitude * * @return static * - * @see http://schema.org/numberOfEmployees + * @see http://schema.org/latitude */ - public function numberOfEmployees($numberOfEmployees) + public function latitude($latitude) { - return $this->setProperty('numberOfEmployees', $numberOfEmployees); + return $this->setProperty('latitude', $latitude); } /** - * A pointer to the organization or person making the offer. + * The official name of the organization, e.g. the registered company name. * - * @param Organization|Organization[]|Person|Person[] $offeredBy + * @param string|string[] $legalName * * @return static * - * @see http://schema.org/offeredBy + * @see http://schema.org/legalName */ - public function offeredBy($offeredBy) + public function legalName($legalName) { - return $this->setProperty('offeredBy', $offeredBy); + return $this->setProperty('legalName', $legalName); } /** - * Products owned by the organization or person. + * An organization identifier that uniquely identifies a legal entity as + * defined in ISO 17442. * - * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns + * @param string|string[] $leiCode * * @return static * - * @see http://schema.org/owns + * @see http://schema.org/leiCode */ - public function owns($owns) + public function leiCode($leiCode) { - return $this->setProperty('owns', $owns); + return $this->setProperty('leiCode', $leiCode); } /** - * The larger organization that this organization is a [[subOrganization]] - * of, if any. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param Organization|Organization[] $parentOrganization + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/parentOrganization + * @see http://schema.org/location */ - public function parentOrganization($parentOrganization) + public function location($location) { - return $this->setProperty('parentOrganization', $parentOrganization); + return $this->setProperty('location', $location); } /** - * 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. When - * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are - * those of the party primarily responsible for the creation of the - * [[CreativeWork]]. - * - * While such policies are most typically expressed in natural language, - * sometimes related information (e.g. indicating a [[funder]]) can be - * expressed using schema.org terminology. + * An associated logo. * - * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples + * @param ImageObject|ImageObject[]|string|string[] $logo * * @return static * - * @see http://schema.org/publishingPrinciples + * @see http://schema.org/logo */ - public function publishingPrinciples($publishingPrinciples) + public function logo($logo) { - return $this->setProperty('publishingPrinciples', $publishingPrinciples); + return $this->setProperty('logo', $logo); } /** - * A review of the item. + * The longitude of a location. For example ```-122.08585``` ([WGS + * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). * - * @param Review|Review[] $review + * @param float|float[]|int|int[]|string|string[] $longitude * * @return static * - * @see http://schema.org/review + * @see http://schema.org/longitude */ - public function review($review) + public function longitude($longitude) { - return $this->setProperty('review', $review); + return $this->setProperty('longitude', $longitude); } /** - * Review of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param Review|Review[] $reviews + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/reviews + * @see http://schema.org/mainEntityOfPage */ - public function reviews($reviews) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('reviews', $reviews); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * A pointer to products or services sought by the organization or person - * (demand). + * A pointer to products or services offered by the organization or person. * - * @param Demand|Demand[] $seeks + * @param Offer|Offer[] $makesOffer * * @return static * - * @see http://schema.org/seeks + * @see http://schema.org/makesOffer */ - public function seeks($seeks) + public function makesOffer($makesOffer) { - return $this->setProperty('seeks', $seeks); + return $this->setProperty('makesOffer', $makesOffer); } /** - * The geographic area where the service is provided. + * A URL to a map of the place. * - * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea + * @param string|string[] $map * * @return static * - * @see http://schema.org/serviceArea + * @see http://schema.org/map */ - public function serviceArea($serviceArea) + public function map($map) { - return $this->setProperty('serviceArea', $serviceArea); + return $this->setProperty('map', $map); } /** - * A slogan or motto associated with the item. + * A URL to a map of the place. * - * @param string|string[] $slogan + * @param string|string[] $maps * * @return static * - * @see http://schema.org/slogan + * @see http://schema.org/maps */ - public function slogan($slogan) + public function maps($maps) { - return $this->setProperty('slogan', $slogan); + return $this->setProperty('maps', $maps); } /** - * 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. + * The total number of individuals that may attend an event or venue. * - * @param Organization|Organization[]|Person|Person[] $sponsor + * @param int|int[] $maximumAttendeeCapacity * * @return static * - * @see http://schema.org/sponsor + * @see http://schema.org/maximumAttendeeCapacity */ - public function sponsor($sponsor) + public function maximumAttendeeCapacity($maximumAttendeeCapacity) { - return $this->setProperty('sponsor', $sponsor); + return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } /** - * A relationship between two organizations where the first includes the - * second, e.g., as a subsidiary. See also: the more specific 'department' - * property. + * A member of an Organization or a ProgramMembership. Organizations can be + * members of organizations; ProgramMembership is typically for individuals. * - * @param Organization|Organization[] $subOrganization + * @param Organization|Organization[]|Person|Person[] $member * * @return static * - * @see http://schema.org/subOrganization + * @see http://schema.org/member */ - public function subOrganization($subOrganization) + public function member($member) { - return $this->setProperty('subOrganization', $subOrganization); + return $this->setProperty('member', $member); } /** - * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US - * or the CIF/NIF in Spain. + * An Organization (or ProgramMembership) to which this Person or + * Organization belongs. * - * @param string|string[] $taxID + * @param Organization|Organization[]|ProgramMembership|ProgramMembership[] $memberOf * * @return static * - * @see http://schema.org/taxID + * @see http://schema.org/memberOf */ - public function taxID($taxID) + public function memberOf($memberOf) { - return $this->setProperty('taxID', $taxID); + return $this->setProperty('memberOf', $memberOf); } /** - * The telephone number. + * A member of this organization. * - * @param string|string[] $telephone + * @param Organization|Organization[]|Person|Person[] $members * * @return static * - * @see http://schema.org/telephone + * @see http://schema.org/members */ - public function telephone($telephone) + public function members($members) { - return $this->setProperty('telephone', $telephone); + return $this->setProperty('members', $members); } /** - * The Value-added Tax ID of the organization or person. + * Either the actual menu as a structured representation, as text, or a URL + * of the menu. * - * @param string|string[] $vatID + * @param Menu|Menu[]|string|string[] $menu * * @return static * - * @see http://schema.org/vatID + * @see http://schema.org/menu */ - public function vatID($vatID) + public function menu($menu) { - return $this->setProperty('vatID', $vatID); + return $this->setProperty('menu', $menu); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * The North American Industry Classification System (NAICS) code for a + * particular organization or business person. * - * @param string|string[] $additionalType + * @param string|string[] $naics * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/naics */ - public function additionalType($additionalType) + public function naics($naics) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('naics', $naics); } /** - * An alias for the item. + * The name of the item. * - * @param string|string[] $alternateName + * @param string|string[] $name * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/name */ - public function alternateName($alternateName) + public function name($name) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('name', $name); } /** - * A description of the item. + * The number of employees in an organization e.g. business. * - * @param string|string[] $description + * @param QuantitativeValue|QuantitativeValue[] $numberOfEmployees * * @return static * - * @see http://schema.org/description + * @see http://schema.org/numberOfEmployees */ - public function description($description) + public function numberOfEmployees($numberOfEmployees) { - return $this->setProperty('description', $description); + return $this->setProperty('numberOfEmployees', $numberOfEmployees); } /** - * 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. + * A pointer to the organization or person making the offer. * - * @param string|string[] $disambiguatingDescription + * @param Organization|Organization[]|Person|Person[] $offeredBy * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/offeredBy */ - public function disambiguatingDescription($disambiguatingDescription) + public function offeredBy($offeredBy) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('offeredBy', $offeredBy); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param string|string[] $openingHours * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/openingHours */ - public function identifier($identifier) + public function openingHours($openingHours) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('openingHours', $openingHours); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * The opening hours of a certain place. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification * * @return static * - * @see http://schema.org/image + * @see http://schema.org/openingHoursSpecification */ - public function image($image) + public function openingHoursSpecification($openingHoursSpecification) { - return $this->setProperty('image', $image); + return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Products owned by the organization or person. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param OwnershipInfo|OwnershipInfo[]|Product|Product[] $owns * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/owns */ - public function mainEntityOfPage($mainEntityOfPage) + public function owns($owns) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('owns', $owns); } /** - * The name of the item. + * The larger organization that this organization is a [[subOrganization]] + * of, if any. * - * @param string|string[] $name + * @param Organization|Organization[] $parentOrganization * * @return static * - * @see http://schema.org/name + * @see http://schema.org/parentOrganization */ - public function name($name) + public function parentOrganization($parentOrganization) { - return $this->setProperty('name', $name); + return $this->setProperty('parentOrganization', $parentOrganization); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc. * - * @param Action|Action[] $potentialAction + * @param string|string[] $paymentAccepted * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/paymentAccepted */ - public function potentialAction($potentialAction) + public function paymentAccepted($paymentAccepted) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('paymentAccepted', $paymentAccepted); } /** - * 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. + * A photograph of this place. * - * @param string|string[] $sameAs + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/photo */ - public function sameAs($sameAs) + public function photo($photo) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('photo', $photo); } /** - * A CreativeWork or Event about this Thing. + * Photographs of this place. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/photos */ - public function subjectOf($subjectOf) + public function photos($photos) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('photos', $photos); } /** - * URL of the item. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param string|string[] $url + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/url + * @see http://schema.org/potentialAction */ - public function url($url) + public function potentialAction($potentialAction) { - return $this->setProperty('url', $url); + return $this->setProperty('potentialAction', $potentialAction); } /** - * A property-value pair representing an additional characteristics of the - * entitity, e.g. a product feature or another characteristic for which - * there is no matching property in schema.org. - * - * Note: Publishers should be aware that applications designed to use - * specific schema.org properties (e.g. http://schema.org/width, - * http://schema.org/color, http://schema.org/gtin13, ...) will typically - * expect such data to be provided using those properties, rather than using - * the generic property/value mechanism. + * The price range of the business, for example ```$$$```. * - * @param PropertyValue|PropertyValue[] $additionalProperty + * @param string|string[] $priceRange * * @return static * - * @see http://schema.org/additionalProperty + * @see http://schema.org/priceRange */ - public function additionalProperty($additionalProperty) + public function priceRange($priceRange) { - return $this->setProperty('additionalProperty', $additionalProperty); + return $this->setProperty('priceRange', $priceRange); } /** - * An amenity feature (e.g. a characteristic or service) of the - * Accommodation. 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. + * A flag to signal that the [[Place]] is open to public visitors. If this + * property is omitted there is no assumed default boolean value * - * @param LocationFeatureSpecification|LocationFeatureSpecification[] $amenityFeature + * @param bool|bool[] $publicAccess * * @return static * - * @see http://schema.org/amenityFeature + * @see http://schema.org/publicAccess */ - public function amenityFeature($amenityFeature) + public function publicAccess($publicAccess) { - return $this->setProperty('amenityFeature', $amenityFeature); + return $this->setProperty('publicAccess', $publicAccess); } /** - * A short textual code (also called "store code") that uniquely identifies - * a place of business. The code is typically assigned by the - * parentOrganization and used in structured URLs. + * 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. When + * applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are + * those of the party primarily responsible for the creation of the + * [[CreativeWork]]. * - * 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. + * While such policies are most typically expressed in natural language, + * sometimes related information (e.g. indicating a [[funder]]) can be + * expressed using schema.org terminology. * - * @param string|string[] $branchCode + * @param CreativeWork|CreativeWork[]|string|string[] $publishingPrinciples * * @return static * - * @see http://schema.org/branchCode + * @see http://schema.org/publishingPrinciples */ - public function branchCode($branchCode) + public function publishingPrinciples($publishingPrinciples) { - return $this->setProperty('branchCode', $branchCode); + return $this->setProperty('publishingPrinciples', $publishingPrinciples); } /** - * The basic containment relation between a place and one that contains it. + * A review of the item. * - * @param Place|Place[] $containedIn + * @param Review|Review[] $review * * @return static * - * @see http://schema.org/containedIn + * @see http://schema.org/review */ - public function containedIn($containedIn) + public function review($review) { - return $this->setProperty('containedIn', $containedIn); + return $this->setProperty('review', $review); } /** - * The basic containment relation between a place and one that contains it. + * Review of the item. * - * @param Place|Place[] $containedInPlace + * @param Review|Review[] $reviews * * @return static * - * @see http://schema.org/containedInPlace + * @see http://schema.org/reviews */ - public function containedInPlace($containedInPlace) + public function reviews($reviews) { - return $this->setProperty('containedInPlace', $containedInPlace); + return $this->setProperty('reviews', $reviews); } /** - * The basic containment relation between a place and another that it - * contains. + * 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. * - * @param Place|Place[] $containsPlace + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/containsPlace + * @see http://schema.org/sameAs */ - public function containsPlace($containsPlace) + public function sameAs($sameAs) { - return $this->setProperty('containsPlace', $containsPlace); + return $this->setProperty('sameAs', $sameAs); } /** - * The geo coordinates of the place. + * A pointer to products or services sought by the organization or person + * (demand). * - * @param GeoCoordinates|GeoCoordinates[]|GeoShape|GeoShape[] $geo + * @param Demand|Demand[] $seeks * * @return static * - * @see http://schema.org/geo + * @see http://schema.org/seeks */ - public function geo($geo) + public function seeks($seeks) { - return $this->setProperty('geo', $geo); + return $this->setProperty('seeks', $seeks); } /** - * A URL to a map of the place. + * The cuisine of the restaurant. * - * @param Map|Map[]|string|string[] $hasMap + * @param string|string[] $servesCuisine * * @return static * - * @see http://schema.org/hasMap + * @see http://schema.org/servesCuisine */ - public function hasMap($hasMap) + public function servesCuisine($servesCuisine) { - return $this->setProperty('hasMap', $hasMap); + return $this->setProperty('servesCuisine', $servesCuisine); } /** - * A flag to signal that the item, event, or place is accessible for free. + * The geographic area where the service is provided. * - * @param bool|bool[] $isAccessibleForFree + * @param AdministrativeArea|AdministrativeArea[]|GeoShape|GeoShape[]|Place|Place[] $serviceArea * * @return static * - * @see http://schema.org/isAccessibleForFree + * @see http://schema.org/serviceArea */ - public function isAccessibleForFree($isAccessibleForFree) + public function serviceArea($serviceArea) { - return $this->setProperty('isAccessibleForFree', $isAccessibleForFree); + return $this->setProperty('serviceArea', $serviceArea); } /** - * The latitude of a location. For example ```37.42242``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * A slogan or motto associated with the item. * - * @param float|float[]|int|int[]|string|string[] $latitude + * @param string|string[] $slogan * * @return static * - * @see http://schema.org/latitude + * @see http://schema.org/slogan */ - public function latitude($latitude) + public function slogan($slogan) { - return $this->setProperty('latitude', $latitude); + return $this->setProperty('slogan', $slogan); } /** - * The longitude of a location. For example ```-122.08585``` ([WGS - * 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). + * Indicates whether it is allowed to smoke in the place, e.g. in the + * restaurant, hotel or hotel room. * - * @param float|float[]|int|int[]|string|string[] $longitude + * @param bool|bool[] $smokingAllowed * * @return static * - * @see http://schema.org/longitude + * @see http://schema.org/smokingAllowed */ - public function longitude($longitude) + public function smokingAllowed($smokingAllowed) { - return $this->setProperty('longitude', $longitude); + return $this->setProperty('smokingAllowed', $smokingAllowed); } /** - * A URL to a map of the place. + * The special opening hours of a certain place. + * + * Use this to explicitly override general opening hours brought in scope by + * [[openingHoursSpecification]] or [[openingHours]]. * - * @param string|string[] $map + * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification * * @return static * - * @see http://schema.org/map + * @see http://schema.org/specialOpeningHoursSpecification */ - public function map($map) + public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) { - return $this->setProperty('map', $map); + return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); } /** - * A URL to a map of the place. + * 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. * - * @param string|string[] $maps + * @param Organization|Organization[]|Person|Person[] $sponsor * * @return static * - * @see http://schema.org/maps + * @see http://schema.org/sponsor */ - public function maps($maps) + public function sponsor($sponsor) { - return $this->setProperty('maps', $maps); + return $this->setProperty('sponsor', $sponsor); } /** - * The total number of individuals that may attend an event or venue. + * An official rating for a lodging business or food establishment, e.g. + * from national associations or standards bodies. Use the author property + * to indicate the rating organization, e.g. as an Organization with name + * such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars). * - * @param int|int[] $maximumAttendeeCapacity + * @param Rating|Rating[] $starRating * * @return static * - * @see http://schema.org/maximumAttendeeCapacity + * @see http://schema.org/starRating */ - public function maximumAttendeeCapacity($maximumAttendeeCapacity) + public function starRating($starRating) { - return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); + return $this->setProperty('starRating', $starRating); } /** - * The opening hours of a certain place. + * A relationship between two organizations where the first includes the + * second, e.g., as a subsidiary. See also: the more specific 'department' + * property. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $openingHoursSpecification + * @param Organization|Organization[] $subOrganization * * @return static * - * @see http://schema.org/openingHoursSpecification + * @see http://schema.org/subOrganization */ - public function openingHoursSpecification($openingHoursSpecification) + public function subOrganization($subOrganization) { - return $this->setProperty('openingHoursSpecification', $openingHoursSpecification); + return $this->setProperty('subOrganization', $subOrganization); } /** - * A photograph of this place. + * A CreativeWork or Event about this Thing. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photo + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/photo + * @see http://schema.org/subjectOf */ - public function photo($photo) + public function subjectOf($subjectOf) { - return $this->setProperty('photo', $photo); + return $this->setProperty('subjectOf', $subjectOf); } /** - * Photographs of this place. + * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US + * or the CIF/NIF in Spain. * - * @param ImageObject|ImageObject[]|Photograph|Photograph[] $photos + * @param string|string[] $taxID * * @return static * - * @see http://schema.org/photos + * @see http://schema.org/taxID */ - public function photos($photos) + public function taxID($taxID) { - return $this->setProperty('photos', $photos); + return $this->setProperty('taxID', $taxID); } /** - * A flag to signal that the [[Place]] is open to public visitors. If this - * property is omitted there is no assumed default boolean value + * The telephone number. * - * @param bool|bool[] $publicAccess + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/publicAccess + * @see http://schema.org/telephone */ - public function publicAccess($publicAccess) + public function telephone($telephone) { - return $this->setProperty('publicAccess', $publicAccess); + return $this->setProperty('telephone', $telephone); } /** - * Indicates whether it is allowed to smoke in the place, e.g. in the - * restaurant, hotel or hotel room. + * URL of the item. * - * @param bool|bool[] $smokingAllowed + * @param string|string[] $url * * @return static * - * @see http://schema.org/smokingAllowed + * @see http://schema.org/url */ - public function smokingAllowed($smokingAllowed) + public function url($url) { - return $this->setProperty('smokingAllowed', $smokingAllowed); + return $this->setProperty('url', $url); } /** - * The special opening hours of a certain place. - * - * Use this to explicitly override general opening hours brought in scope by - * [[openingHoursSpecification]] or [[openingHours]]. + * The Value-added Tax ID of the organization or person. * - * @param OpeningHoursSpecification|OpeningHoursSpecification[] $specialOpeningHoursSpecification + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/specialOpeningHoursSpecification + * @see http://schema.org/vatID */ - public function specialOpeningHoursSpecification($specialOpeningHoursSpecification) + public function vatID($vatID) { - return $this->setProperty('specialOpeningHoursSpecification', $specialOpeningHoursSpecification); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/WorkersUnion.php b/src/WorkersUnion.php index 36f0e2717..5be6b7b2f 100644 --- a/src/WorkersUnion.php +++ b/src/WorkersUnion.php @@ -15,6 +15,25 @@ */ class WorkersUnion extends BaseType implements OrganizationContract, ThingContract { + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -44,6 +63,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * The geographic area where a service or offered item is provided. * @@ -146,6 +179,37 @@ public function department($department) return $this->setProperty('department', $department); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * The date that this organization was dissolved. * @@ -377,6 +441,39 @@ public function hasPOS($hasPOS) return $this->setProperty('hasPOS', $hasPOS); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * The International Standard of Industrial Classification of All Economic * Activities (ISIC), Revision 4 code for a particular organization, @@ -451,6 +548,22 @@ public function logo($logo) return $this->setProperty('logo', $logo); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A pointer to products or services offered by the organization or person. * @@ -524,6 +637,20 @@ public function naics($naics) return $this->setProperty('naics', $naics); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + /** * The number of employees in an organization e.g. business. * @@ -581,6 +708,21 @@ public function parentOrganization($parentOrganization) return $this->setProperty('parentOrganization', $parentOrganization); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * The publishingPrinciples property indicates (typically via [[URL]]) a * document describing the editorial principles of an [[Organization]] (or @@ -633,6 +775,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A pointer to products or services sought by the organization or person * (demand). @@ -708,6 +866,20 @@ public function subOrganization($subOrganization) return $this->setProperty('subOrganization', $subOrganization); } + /** + * A CreativeWork or Event about this Thing. + * + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * + * @return static + * + * @see http://schema.org/subjectOf + */ + public function subjectOf($subjectOf) + { + return $this->setProperty('subjectOf', $subjectOf); + } + /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US * or the CIF/NIF in Spain. @@ -738,203 +910,31 @@ public function telephone($telephone) } /** - * The Value-added Tax ID of the organization or person. - * - * @param string|string[] $vatID - * - * @return static - * - * @see http://schema.org/vatID - */ - public function vatID($vatID) - { - return $this->setProperty('vatID', $vatID); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. - * - * @param string|string[] $sameAs - * - * @return static - * - * @see http://schema.org/sameAs - */ - public function sameAs($sameAs) - { - return $this->setProperty('sameAs', $sameAs); - } - - /** - * A CreativeWork or Event about this Thing. + * URL of the item. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $url * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/url */ - public function subjectOf($subjectOf) + public function url($url) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('url', $url); } /** - * URL of the item. + * The Value-added Tax ID of the organization or person. * - * @param string|string[] $url + * @param string|string[] $vatID * * @return static * - * @see http://schema.org/url + * @see http://schema.org/vatID */ - public function url($url) + public function vatID($vatID) { - return $this->setProperty('url', $url); + return $this->setProperty('vatID', $vatID); } } diff --git a/src/WriteAction.php b/src/WriteAction.php index e7329dbaf..6a77e58d2 100644 --- a/src/WriteAction.php +++ b/src/WriteAction.php @@ -15,48 +15,36 @@ class WriteAction extends BaseType implements CreateActionContract, ActionContract, ThingContract { /** - * 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](http://tools.ietf.org/html/bcp47). See also - * [[availableLanguage]]. - * - * @param Language|Language[]|string|string[] $inLanguage - * - * @return static - * - * @see http://schema.org/inLanguage - */ - public function inLanguage($inLanguage) - { - return $this->setProperty('inLanguage', $inLanguage); - } - - /** - * A sub property of instrument. The language used on this action. + * Indicates the current disposition of the Action. * - * @param Language|Language[] $language + * @param ActionStatusType|ActionStatusType[] $actionStatus * * @return static * - * @see http://schema.org/language + * @see http://schema.org/actionStatus */ - public function language($language) + public function actionStatus($actionStatus) { - return $this->setProperty('language', $language); + return $this->setProperty('actionStatus', $actionStatus); } /** - * Indicates the current disposition of the Action. + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. * - * @param ActionStatusType|ActionStatusType[] $actionStatus + * @param string|string[] $additionalType * * @return static * - * @see http://schema.org/actionStatus + * @see http://schema.org/additionalType */ - public function actionStatus($actionStatus) + public function additionalType($additionalType) { - return $this->setProperty('actionStatus', $actionStatus); + return $this->setProperty('additionalType', $additionalType); } /** @@ -75,311 +63,309 @@ public function agent($agent) } /** - * The endTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to end. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from January to *December*. For media, including audio - * and video, it's the time offset of the end of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * An alias for the item. * - * @param \DateTimeInterface|\DateTimeInterface[] $endTime + * @param string|string[] $alternateName * * @return static * - * @see http://schema.org/endTime + * @see http://schema.org/alternateName */ - public function endTime($endTime) + public function alternateName($alternateName) { - return $this->setProperty('endTime', $endTime); + return $this->setProperty('alternateName', $alternateName); } /** - * For failed actions, more information on the cause of the failure. + * A description of the item. * - * @param Thing|Thing[] $error + * @param string|string[] $description * * @return static * - * @see http://schema.org/error + * @see http://schema.org/description */ - public function error($error) + public function description($description) { - return $this->setProperty('error', $error); + return $this->setProperty('description', $description); } /** - * The object that helped the agent perform the action. e.g. John wrote a - * book with *a pen*. + * 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. * - * @param Thing|Thing[] $instrument + * @param string|string[] $disambiguatingDescription * * @return static * - * @see http://schema.org/instrument + * @see http://schema.org/disambiguatingDescription */ - public function instrument($instrument) + public function disambiguatingDescription($disambiguatingDescription) { - return $this->setProperty('instrument', $instrument); + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); } /** - * The location of for example where the event is happening, an organization - * is located, or where an action takes place. + * The endTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to end. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from January to *December*. For media, including audio + * and video, it's the time offset of the end of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location + * @param \DateTimeInterface|\DateTimeInterface[] $endTime * * @return static * - * @see http://schema.org/location + * @see http://schema.org/endTime */ - public function location($location) + public function endTime($endTime) { - return $this->setProperty('location', $location); + return $this->setProperty('endTime', $endTime); } /** - * The object upon which the action is carried out, whose state is kept - * intact or changed. Also known as the semantic roles patient, affected or - * undergoer (which change their state) or theme (which doesn't). e.g. John - * read *a book*. + * For failed actions, more information on the cause of the failure. * - * @param Thing|Thing[] $object + * @param Thing|Thing[] $error * * @return static * - * @see http://schema.org/object + * @see http://schema.org/error */ - public function object($object) + public function error($error) { - return $this->setProperty('object', $object); + return $this->setProperty('error', $error); } /** - * Other co-agents that participated in the action indirectly. e.g. John - * wrote a book with *Steve*. + * 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](/docs/datamodel.html#identifierBg) for more details. * - * @param Organization|Organization[]|Person|Person[] $participant + * @param PropertyValue|PropertyValue[]|string|string[] $identifier * * @return static * - * @see http://schema.org/participant + * @see http://schema.org/identifier */ - public function participant($participant) + public function identifier($identifier) { - return $this->setProperty('participant', $participant); + return $this->setProperty('identifier', $identifier); } /** - * The result produced in the action. e.g. John wrote *a book*. + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. * - * @param Thing|Thing[] $result + * @param ImageObject|ImageObject[]|string|string[] $image * * @return static * - * @see http://schema.org/result + * @see http://schema.org/image */ - public function result($result) + public function image($image) { - return $this->setProperty('result', $result); + return $this->setProperty('image', $image); } /** - * The startTime of something. For a reserved event or service (e.g. - * FoodEstablishmentReservation), the time that it is expected to start. For - * actions that span a period of time, when the action was performed. e.g. - * John wrote a book from *January* to December. For media, including audio - * and video, it's the time offset of the start of a clip within a larger - * file. - * - * Note that Event uses startDate/endDate instead of startTime/endTime, even - * when describing dates with times. This situation may be clarified in - * future revisions. + * 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](http://tools.ietf.org/html/bcp47). See also + * [[availableLanguage]]. * - * @param \DateTimeInterface|\DateTimeInterface[] $startTime + * @param Language|Language[]|string|string[] $inLanguage * * @return static * - * @see http://schema.org/startTime + * @see http://schema.org/inLanguage */ - public function startTime($startTime) + public function inLanguage($inLanguage) { - return $this->setProperty('startTime', $startTime); + return $this->setProperty('inLanguage', $inLanguage); } /** - * Indicates a target EntryPoint for an Action. + * The object that helped the agent perform the action. e.g. John wrote a + * book with *a pen*. * - * @param EntryPoint|EntryPoint[] $target + * @param Thing|Thing[] $instrument * * @return static * - * @see http://schema.org/target + * @see http://schema.org/instrument */ - public function target($target) + public function instrument($instrument) { - return $this->setProperty('target', $target); + return $this->setProperty('instrument', $instrument); } /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. + * A sub property of instrument. The language used on this action. * - * @param string|string[] $additionalType + * @param Language|Language[] $language * * @return static * - * @see http://schema.org/additionalType + * @see http://schema.org/language */ - public function additionalType($additionalType) + public function language($language) { - return $this->setProperty('additionalType', $additionalType); + return $this->setProperty('language', $language); } /** - * An alias for the item. + * The location of for example where the event is happening, an organization + * is located, or where an action takes place. * - * @param string|string[] $alternateName + * @param Place|Place[]|PostalAddress|PostalAddress[]|string|string[] $location * * @return static * - * @see http://schema.org/alternateName + * @see http://schema.org/location */ - public function alternateName($alternateName) + public function location($location) { - return $this->setProperty('alternateName', $alternateName); + return $this->setProperty('location', $location); } /** - * A description of the item. + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. * - * @param string|string[] $description + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage * * @return static * - * @see http://schema.org/description + * @see http://schema.org/mainEntityOfPage */ - public function description($description) + public function mainEntityOfPage($mainEntityOfPage) { - return $this->setProperty('description', $description); + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); } /** - * 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. + * The name of the item. * - * @param string|string[] $disambiguatingDescription + * @param string|string[] $name * * @return static * - * @see http://schema.org/disambiguatingDescription + * @see http://schema.org/name */ - public function disambiguatingDescription($disambiguatingDescription) + public function name($name) { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + return $this->setProperty('name', $name); } /** - * 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](/docs/datamodel.html#identifierBg) for more details. + * The object upon which the action is carried out, whose state is kept + * intact or changed. Also known as the semantic roles patient, affected or + * undergoer (which change their state) or theme (which doesn't). e.g. John + * read *a book*. * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * @param Thing|Thing[] $object * * @return static * - * @see http://schema.org/identifier + * @see http://schema.org/object */ - public function identifier($identifier) + public function object($object) { - return $this->setProperty('identifier', $identifier); + return $this->setProperty('object', $object); } /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. + * Other co-agents that participated in the action indirectly. e.g. John + * wrote a book with *Steve*. * - * @param ImageObject|ImageObject[]|string|string[] $image + * @param Organization|Organization[]|Person|Person[] $participant * * @return static * - * @see http://schema.org/image + * @see http://schema.org/participant */ - public function image($image) + public function participant($participant) { - return $this->setProperty('image', $image); + return $this->setProperty('participant', $participant); } /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * @param Action|Action[] $potentialAction * * @return static * - * @see http://schema.org/mainEntityOfPage + * @see http://schema.org/potentialAction */ - public function mainEntityOfPage($mainEntityOfPage) + public function potentialAction($potentialAction) { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + return $this->setProperty('potentialAction', $potentialAction); } /** - * The name of the item. + * The result produced in the action. e.g. John wrote *a book*. * - * @param string|string[] $name + * @param Thing|Thing[] $result * * @return static * - * @see http://schema.org/name + * @see http://schema.org/result */ - public function name($name) + public function result($result) { - return $this->setProperty('name', $name); + return $this->setProperty('result', $result); } /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. + * 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. * - * @param Action|Action[] $potentialAction + * @param string|string[] $sameAs * * @return static * - * @see http://schema.org/potentialAction + * @see http://schema.org/sameAs */ - public function potentialAction($potentialAction) + public function sameAs($sameAs) { - return $this->setProperty('potentialAction', $potentialAction); + return $this->setProperty('sameAs', $sameAs); } /** - * 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. + * The startTime of something. For a reserved event or service (e.g. + * FoodEstablishmentReservation), the time that it is expected to start. For + * actions that span a period of time, when the action was performed. e.g. + * John wrote a book from *January* to December. For media, including audio + * and video, it's the time offset of the start of a clip within a larger + * file. + * + * Note that Event uses startDate/endDate instead of startTime/endTime, even + * when describing dates with times. This situation may be clarified in + * future revisions. * - * @param string|string[] $sameAs + * @param \DateTimeInterface|\DateTimeInterface[] $startTime * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/startTime */ - public function sameAs($sameAs) + public function startTime($startTime) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('startTime', $startTime); } /** @@ -396,6 +382,20 @@ public function subjectOf($subjectOf) return $this->setProperty('subjectOf', $subjectOf); } + /** + * Indicates a target EntryPoint for an Action. + * + * @param EntryPoint|EntryPoint[] $target + * + * @return static + * + * @see http://schema.org/target + */ + public function target($target) + { + return $this->setProperty('target', $target); + } + /** * URL of the item. * diff --git a/src/Zoo.php b/src/Zoo.php index f0f533b27..fa3ee16a6 100644 --- a/src/Zoo.php +++ b/src/Zoo.php @@ -14,35 +14,6 @@ */ class Zoo extends BaseType implements CivicStructureContract, PlaceContract, ThingContract { - /** - * 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 '-'. - * - * * Days are specified using the following two-letter combinations: - * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. - * * Times are specified using 24:00 time. For example, 3pm is specified as - * ```15:00```. - * * Here is an example: <time itemprop="openingHours" - * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays - * 4-8pm</time>. - * * If a business is open 7 days a week, then it can be specified as - * <time itemprop="openingHours" - * datetime="Mo-Su">Monday through Sunday, all - * day</time>. - * - * @param string|string[] $openingHours - * - * @return static - * - * @see http://schema.org/openingHours - */ - public function openingHours($openingHours) - { - return $this->setProperty('openingHours', $openingHours); - } - /** * A property-value pair representing an additional characteristics of the * entitity, e.g. a product feature or another characteristic for which @@ -65,6 +36,25 @@ public function additionalProperty($additionalProperty) return $this->setProperty('additionalProperty', $additionalProperty); } + /** + * 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. In RDFa + * syntax, it is better to use the native RDFa syntax - the 'typeof' + * attribute - for multiple types. Schema.org tools may have only weaker + * understanding of extra types, in particular those defined externally. + * + * @param string|string[] $additionalType + * + * @return static + * + * @see http://schema.org/additionalType + */ + public function additionalType($additionalType) + { + return $this->setProperty('additionalType', $additionalType); + } + /** * Physical address of the item. * @@ -94,6 +84,20 @@ public function aggregateRating($aggregateRating) return $this->setProperty('aggregateRating', $aggregateRating); } + /** + * An alias for the item. + * + * @param string|string[] $alternateName + * + * @return static + * + * @see http://schema.org/alternateName + */ + public function alternateName($alternateName) + { + return $this->setProperty('alternateName', $alternateName); + } + /** * An amenity feature (e.g. a characteristic or service) of the * Accommodation. This generic property does not make a statement about @@ -174,6 +178,37 @@ public function containsPlace($containsPlace) return $this->setProperty('containsPlace', $containsPlace); } + /** + * A description of the item. + * + * @param string|string[] $description + * + * @return static + * + * @see http://schema.org/description + */ + public function description($description) + { + return $this->setProperty('description', $description); + } + + /** + * 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. + * + * @param string|string[] $disambiguatingDescription + * + * @return static + * + * @see http://schema.org/disambiguatingDescription + */ + public function disambiguatingDescription($disambiguatingDescription) + { + return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); + } + /** * Upcoming or past event associated with this place, organization, or * action. @@ -262,6 +297,39 @@ public function hasMap($hasMap) return $this->setProperty('hasMap', $hasMap); } + /** + * 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](/docs/datamodel.html#identifierBg) for more details. + * + * @param PropertyValue|PropertyValue[]|string|string[] $identifier + * + * @return static + * + * @see http://schema.org/identifier + */ + public function identifier($identifier) + { + return $this->setProperty('identifier', $identifier); + } + + /** + * An image of the item. This can be a [[URL]] or a fully described + * [[ImageObject]]. + * + * @param ImageObject|ImageObject[]|string|string[] $image + * + * @return static + * + * @see http://schema.org/image + */ + public function image($image) + { + return $this->setProperty('image', $image); + } + /** * A flag to signal that the item, event, or place is accessible for free. * @@ -336,6 +404,22 @@ public function longitude($longitude) return $this->setProperty('longitude', $longitude); } + /** + * Indicates a page (or other CreativeWork) for which this thing is the main + * entity being described. See [background + * notes](/docs/datamodel.html#mainEntityBackground) for details. + * + * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage + * + * @return static + * + * @see http://schema.org/mainEntityOfPage + */ + public function mainEntityOfPage($mainEntityOfPage) + { + return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); + } + /** * A URL to a map of the place. * @@ -378,6 +462,49 @@ public function maximumAttendeeCapacity($maximumAttendeeCapacity) return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity); } + /** + * The name of the item. + * + * @param string|string[] $name + * + * @return static + * + * @see http://schema.org/name + */ + public function name($name) + { + return $this->setProperty('name', $name); + } + + /** + * 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 '-'. + * + * * Days are specified using the following two-letter combinations: + * ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```. + * * Times are specified using 24:00 time. For example, 3pm is specified as + * ```15:00```. + * * Here is an example: <time itemprop="openingHours" + * datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays + * 4-8pm</time>. + * * If a business is open 7 days a week, then it can be specified as + * <time itemprop="openingHours" + * datetime="Mo-Su">Monday through Sunday, all + * day</time>. + * + * @param string|string[] $openingHours + * + * @return static + * + * @see http://schema.org/openingHours + */ + public function openingHours($openingHours) + { + return $this->setProperty('openingHours', $openingHours); + } + /** * The opening hours of a certain place. * @@ -420,6 +547,21 @@ public function photos($photos) return $this->setProperty('photos', $photos); } + /** + * Indicates a potential Action, which describes an idealized action in + * which this thing would play an 'object' role. + * + * @param Action|Action[] $potentialAction + * + * @return static + * + * @see http://schema.org/potentialAction + */ + public function potentialAction($potentialAction) + { + return $this->setProperty('potentialAction', $potentialAction); + } + /** * A flag to signal that the [[Place]] is open to public visitors. If this * property is omitted there is no assumed default boolean value @@ -463,6 +605,22 @@ public function reviews($reviews) return $this->setProperty('reviews', $reviews); } + /** + * 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. + * + * @param string|string[] $sameAs + * + * @return static + * + * @see http://schema.org/sameAs + */ + public function sameAs($sameAs) + { + return $this->setProperty('sameAs', $sameAs); + } + /** * A slogan or motto associated with the item. * @@ -510,189 +668,31 @@ public function specialOpeningHoursSpecification($specialOpeningHoursSpecificati } /** - * The telephone number. - * - * @param string|string[] $telephone - * - * @return static - * - * @see http://schema.org/telephone - */ - public function telephone($telephone) - { - return $this->setProperty('telephone', $telephone); - } - - /** - * 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. In RDFa - * syntax, it is better to use the native RDFa syntax - the 'typeof' - * attribute - for multiple types. Schema.org tools may have only weaker - * understanding of extra types, in particular those defined externally. - * - * @param string|string[] $additionalType - * - * @return static - * - * @see http://schema.org/additionalType - */ - public function additionalType($additionalType) - { - return $this->setProperty('additionalType', $additionalType); - } - - /** - * An alias for the item. - * - * @param string|string[] $alternateName - * - * @return static - * - * @see http://schema.org/alternateName - */ - public function alternateName($alternateName) - { - return $this->setProperty('alternateName', $alternateName); - } - - /** - * A description of the item. - * - * @param string|string[] $description - * - * @return static - * - * @see http://schema.org/description - */ - public function description($description) - { - return $this->setProperty('description', $description); - } - - /** - * 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. - * - * @param string|string[] $disambiguatingDescription - * - * @return static - * - * @see http://schema.org/disambiguatingDescription - */ - public function disambiguatingDescription($disambiguatingDescription) - { - return $this->setProperty('disambiguatingDescription', $disambiguatingDescription); - } - - /** - * 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](/docs/datamodel.html#identifierBg) for more details. - * - * @param PropertyValue|PropertyValue[]|string|string[] $identifier - * - * @return static - * - * @see http://schema.org/identifier - */ - public function identifier($identifier) - { - return $this->setProperty('identifier', $identifier); - } - - /** - * An image of the item. This can be a [[URL]] or a fully described - * [[ImageObject]]. - * - * @param ImageObject|ImageObject[]|string|string[] $image - * - * @return static - * - * @see http://schema.org/image - */ - public function image($image) - { - return $this->setProperty('image', $image); - } - - /** - * Indicates a page (or other CreativeWork) for which this thing is the main - * entity being described. See [background - * notes](/docs/datamodel.html#mainEntityBackground) for details. - * - * @param CreativeWork|CreativeWork[]|string|string[] $mainEntityOfPage - * - * @return static - * - * @see http://schema.org/mainEntityOfPage - */ - public function mainEntityOfPage($mainEntityOfPage) - { - return $this->setProperty('mainEntityOfPage', $mainEntityOfPage); - } - - /** - * The name of the item. - * - * @param string|string[] $name - * - * @return static - * - * @see http://schema.org/name - */ - public function name($name) - { - return $this->setProperty('name', $name); - } - - /** - * Indicates a potential Action, which describes an idealized action in - * which this thing would play an 'object' role. - * - * @param Action|Action[] $potentialAction - * - * @return static - * - * @see http://schema.org/potentialAction - */ - public function potentialAction($potentialAction) - { - return $this->setProperty('potentialAction', $potentialAction); - } - - /** - * 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. + * A CreativeWork or Event about this Thing. * - * @param string|string[] $sameAs + * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf * * @return static * - * @see http://schema.org/sameAs + * @see http://schema.org/subjectOf */ - public function sameAs($sameAs) + public function subjectOf($subjectOf) { - return $this->setProperty('sameAs', $sameAs); + return $this->setProperty('subjectOf', $subjectOf); } /** - * A CreativeWork or Event about this Thing. + * The telephone number. * - * @param CreativeWork|CreativeWork[]|Event|Event[] $subjectOf + * @param string|string[] $telephone * * @return static * - * @see http://schema.org/subjectOf + * @see http://schema.org/telephone */ - public function subjectOf($subjectOf) + public function telephone($telephone) { - return $this->setProperty('subjectOf', $subjectOf); + return $this->setProperty('telephone', $telephone); } /** From d73128459120ca9d971e1618658fa68dc162d1e5 Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 14:24:43 +0200 Subject: [PATCH 09/13] fix duplicate parents --- generator/Type.php | 18 ++++++++---------- generator/templates/twig/Contract.php.twig | 4 ---- generator/templates/twig/Type.php.twig | 21 +-------------------- 3 files changed, 9 insertions(+), 34 deletions(-) diff --git a/generator/Type.php b/generator/Type.php index d7082ff55..e41a87339 100644 --- a/generator/Type.php +++ b/generator/Type.php @@ -10,9 +10,6 @@ class Type /** @var string[] */ public $parents = []; - /** @var string[] */ - public $grandParents = []; - /** @var string */ public $description; @@ -25,6 +22,9 @@ class Type /** @var string */ public $resource; + /** @var bool */ + protected $parentsLoaded = false; + public function addProperty(Property $property) { $this->properties[$property->name] = $property; @@ -41,11 +41,11 @@ public function addConstant(Constant $constant) public function setTypeCollection(TypeCollection $typeCollection): void { - if ($this->parentProperties !== null) { + if ($this->parentsLoaded) { return; } - $this->parentProperties = []; + $this->parentsLoaded = true; if (empty($this->parents)) { return; @@ -62,15 +62,13 @@ public function setTypeCollection(TypeCollection $typeCollection): void $parent = $types[$parent]; $parent->setTypeCollection($typeCollection); - $this->grandParents = array_merge($parent->parents, $parent->grandParents); + $this->parents = array_unique(array_merge($this->parents, $parent->parents)); + + ksort($this->parents); foreach ($parent->properties as $property) { $this->addProperty($property); } - - foreach ($parent->parentProperties as $parentProperty) { - $this->addProperty($parentProperty); - } } } } diff --git a/generator/templates/twig/Contract.php.twig b/generator/templates/twig/Contract.php.twig index c20656949..91c76e0bf 100644 --- a/generator/templates/twig/Contract.php.twig +++ b/generator/templates/twig/Contract.php.twig @@ -7,9 +7,5 @@ interface {{ type.name }}Contract {% for property in type.properties if not property.pending %} public function {{ property.name }}(${{ property.name }}); -{% endfor %} -{% for parentProperty in type.parentProperties if not parentProperty.pending %} - public function {{ parentProperty.name }}(${{ parentProperty.name }}); - {% endfor %} } diff --git a/generator/templates/twig/Type.php.twig b/generator/templates/twig/Type.php.twig index ca714fdd7..9b8b51cdb 100644 --- a/generator/templates/twig/Type.php.twig +++ b/generator/templates/twig/Type.php.twig @@ -5,9 +5,6 @@ namespace Spatie\SchemaOrg; {% for parent in type.parents %} use \Spatie\SchemaOrg\Contracts\{{ parent }}Contract; {% endfor %} -{% for grandParent in type.grandParents %} -use \Spatie\SchemaOrg\Contracts\{{ grandParent }}Contract; -{% endfor %} /** * {{ type.description | doc(0) }} @@ -18,7 +15,7 @@ use \Spatie\SchemaOrg\Contracts\{{ grandParent }}Contract; * @method static {{ property.name }}(${{ property.name }}) The value should be instance of pending types {{ property.ranges | join('|') }} {% endfor %} */ -class {{ type.name }} extends BaseType{% if type.parents or type.grandParents %} implements {% endif %}{{ type.parents|map(parent => "#{parent}Contract")|join(', ') }}{% if type.grandParents %}, {% endif %}{{ type.grandParents|map(grandParent => "#{grandParent}Contract")|join(', ') }} +class {{ type.name }} extends BaseType{% if type.parents %} implements {% endif %}{{ type.parents|map(parent => "#{parent}Contract")|join(', ') }} { {% for constant in type.constants %} /** @@ -44,21 +41,5 @@ class {{ type.name }} extends BaseType{% if type.parents or type.grandParents %} return $this->setProperty('{{ property.name }}', ${{ property.name }}); } -{% endfor %} -{% for parentProperty in type.parentProperties if not parentProperty.pending %} - /** - * {{ parentProperty.description | doc(1) }} - * - * @param {{ parentProperty.ranges | join('|') }} ${{ parentProperty.name }} - * - * @return static - * - * @see {{ parentProperty.resource }} - */ - public function {{ parentProperty.name }}(${{ parentProperty.name }}) - { - return $this->setProperty('{{ parentProperty.name }}', ${{ parentProperty.name }}); - } - {% endfor %} } From 64a434dc2d01a08de0a37d75469d36629df54682 Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 14:24:52 +0200 Subject: [PATCH 10/13] generated files --- src/BookSeries.php | 4 ++-- src/Campground.php | 6 +++--- src/CreativeWorkSeries.php | 4 ++-- src/CreditCard.php | 4 +++- src/Dentist.php | 4 ++-- src/FireStation.php | 6 +++--- src/Hospital.php | 6 ++++-- src/HowToDirection.php | 3 ++- src/HowToSection.php | 3 ++- src/HowToStep.php | 3 ++- src/HowToTip.php | 3 ++- src/MovieSeries.php | 4 ++-- src/MovieTheater.php | 6 +++--- src/PaymentCard.php | 5 +++-- src/Periodical.php | 4 ++-- src/PoliceStation.php | 6 +++--- src/RadioSeries.php | 4 ++-- src/StadiumOrArena.php | 6 +++--- src/TVSeason.php | 3 +-- src/TVSeries.php | 5 ++--- src/VideoGameSeries.php | 4 ++-- 21 files changed, 50 insertions(+), 43 deletions(-) diff --git a/src/BookSeries.php b/src/BookSeries.php index 18fd409dc..75ecec583 100644 --- a/src/BookSeries.php +++ b/src/BookSeries.php @@ -5,8 +5,8 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A series of books. Included books can be indicated with the hasPart property. @@ -14,7 +14,7 @@ * @see http://schema.org/BookSeries * */ -class BookSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract +class BookSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract { /** * The subject matter of the content. diff --git a/src/Campground.php b/src/Campground.php index 9cbc132e1..6b0abf0df 100644 --- a/src/Campground.php +++ b/src/Campground.php @@ -4,10 +4,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; -use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; -use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; /** * A camping site, campsite, or [[Campground]] is a place used for overnight @@ -32,7 +32,7 @@ * @see http://schema.org/Campground * */ -class Campground extends BaseType implements CivicStructureContract, LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class Campground extends BaseType implements CivicStructureContract, LodgingBusinessContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/CreativeWorkSeries.php b/src/CreativeWorkSeries.php index b18d1ac6e..2cbbb57f6 100644 --- a/src/CreativeWorkSeries.php +++ b/src/CreativeWorkSeries.php @@ -4,8 +4,8 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A CreativeWorkSeries in schema.org is a group of related items, typically but @@ -29,7 +29,7 @@ * @see http://schema.org/CreativeWorkSeries * */ -class CreativeWorkSeries extends BaseType implements CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract +class CreativeWorkSeries extends BaseType implements CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract { /** * The subject matter of the content. diff --git a/src/CreditCard.php b/src/CreditCard.php index 4d5009369..17447a296 100644 --- a/src/CreditCard.php +++ b/src/CreditCard.php @@ -5,9 +5,11 @@ use \Spatie\SchemaOrg\Contracts\PaymentCardContract; use \Spatie\SchemaOrg\Contracts\LoanOrCreditContract; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\PaymentMethodContract; use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; /** * A card payment method of a particular brand or name. Used to mark up a @@ -26,7 +28,7 @@ * @see http://schema.org/CreditCard * */ -class CreditCard extends BaseType implements PaymentCardContract, LoanOrCreditContract, FinancialProductContract, ServiceContract, IntangibleContract, ThingContract +class CreditCard extends BaseType implements PaymentCardContract, LoanOrCreditContract, FinancialProductContract, PaymentMethodContract, ServiceContract, IntangibleContract, ThingContract, EnumerationContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Dentist.php b/src/Dentist.php index 5ea26bffe..473489480 100644 --- a/src/Dentist.php +++ b/src/Dentist.php @@ -5,8 +5,8 @@ use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; -use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; /** * A dentist. @@ -14,7 +14,7 @@ * @see http://schema.org/Dentist * */ -class Dentist extends BaseType implements MedicalOrganizationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class Dentist extends BaseType implements MedicalOrganizationContract, LocalBusinessContract, OrganizationContract, ThingContract, PlaceContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/FireStation.php b/src/FireStation.php index 96407fb13..3c94088a1 100644 --- a/src/FireStation.php +++ b/src/FireStation.php @@ -4,10 +4,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; -use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; -use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; /** * A fire station. With firemen. @@ -15,7 +15,7 @@ * @see http://schema.org/FireStation * */ -class FireStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class FireStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/Hospital.php b/src/Hospital.php index d20fa7963..1579e7666 100644 --- a/src/Hospital.php +++ b/src/Hospital.php @@ -5,8 +5,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; -use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; /** * A hospital. @@ -14,7 +16,7 @@ * @see http://schema.org/Hospital * */ -class Hospital extends BaseType implements CivicStructureContract, EmergencyServiceContract, MedicalOrganizationContract, OrganizationContract, ThingContract +class Hospital extends BaseType implements CivicStructureContract, EmergencyServiceContract, MedicalOrganizationContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/HowToDirection.php b/src/HowToDirection.php index fe5854fd4..47d4434ab 100644 --- a/src/HowToDirection.php +++ b/src/HowToDirection.php @@ -4,6 +4,7 @@ use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +14,7 @@ * @see http://schema.org/HowToDirection * */ -class HowToDirection extends BaseType implements ListItemContract, CreativeWorkContract, ThingContract +class HowToDirection extends BaseType implements ListItemContract, CreativeWorkContract, IntangibleContract, ThingContract { /** * The subject matter of the content. diff --git a/src/HowToSection.php b/src/HowToSection.php index 952fdd43f..071203b58 100644 --- a/src/HowToSection.php +++ b/src/HowToSection.php @@ -5,6 +5,7 @@ use \Spatie\SchemaOrg\Contracts\ItemListContract; use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +15,7 @@ * @see http://schema.org/HowToSection * */ -class HowToSection extends BaseType implements ItemListContract, ListItemContract, CreativeWorkContract, ThingContract +class HowToSection extends BaseType implements ItemListContract, ListItemContract, CreativeWorkContract, IntangibleContract, ThingContract { /** * The subject matter of the content. diff --git a/src/HowToStep.php b/src/HowToStep.php index e0a0f2094..4f172a7c9 100644 --- a/src/HowToStep.php +++ b/src/HowToStep.php @@ -5,6 +5,7 @@ use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\ItemListContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +15,7 @@ * @see http://schema.org/HowToStep * */ -class HowToStep extends BaseType implements ListItemContract, ItemListContract, CreativeWorkContract, ThingContract +class HowToStep extends BaseType implements ListItemContract, ItemListContract, CreativeWorkContract, IntangibleContract, ThingContract { /** * The subject matter of the content. diff --git a/src/HowToTip.php b/src/HowToTip.php index bc1d9c244..e85b08ed8 100644 --- a/src/HowToTip.php +++ b/src/HowToTip.php @@ -4,6 +4,7 @@ use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +16,7 @@ * @see http://schema.org/HowToTip * */ -class HowToTip extends BaseType implements ListItemContract, CreativeWorkContract, ThingContract +class HowToTip extends BaseType implements ListItemContract, CreativeWorkContract, IntangibleContract, ThingContract { /** * The subject matter of the content. diff --git a/src/MovieSeries.php b/src/MovieSeries.php index 67d0dfb6f..8dd6c8113 100644 --- a/src/MovieSeries.php +++ b/src/MovieSeries.php @@ -5,8 +5,8 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A series of movies. Included movies can be indicated with the hasPart @@ -15,7 +15,7 @@ * @see http://schema.org/MovieSeries * */ -class MovieSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract +class MovieSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract { /** * The subject matter of the content. diff --git a/src/MovieTheater.php b/src/MovieTheater.php index 1428ce3d4..90fdfd8fd 100644 --- a/src/MovieTheater.php +++ b/src/MovieTheater.php @@ -4,10 +4,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; -use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; -use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; /** * A movie theater. @@ -15,7 +15,7 @@ * @see http://schema.org/MovieTheater * */ -class MovieTheater extends BaseType implements CivicStructureContract, EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class MovieTheater extends BaseType implements CivicStructureContract, EntertainmentBusinessContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/PaymentCard.php b/src/PaymentCard.php index 9daebc0bd..050588fd2 100644 --- a/src/PaymentCard.php +++ b/src/PaymentCard.php @@ -4,9 +4,10 @@ use \Spatie\SchemaOrg\Contracts\FinancialProductContract; use \Spatie\SchemaOrg\Contracts\PaymentMethodContract; -use \Spatie\SchemaOrg\Contracts\EnumerationContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; /** * A payment method using a credit, debit, store or other card to associate the @@ -15,7 +16,7 @@ * @see http://schema.org/PaymentCard * */ -class PaymentCard extends BaseType implements FinancialProductContract, PaymentMethodContract, EnumerationContract, IntangibleContract, ThingContract +class PaymentCard extends BaseType implements FinancialProductContract, PaymentMethodContract, ServiceContract, IntangibleContract, ThingContract, EnumerationContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Periodical.php b/src/Periodical.php index 44837d402..509aade31 100644 --- a/src/Periodical.php +++ b/src/Periodical.php @@ -5,8 +5,8 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A publication in any medium issued in successive parts bearing numerical or @@ -19,7 +19,7 @@ * @see http://schema.org/Periodical * */ -class Periodical extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract +class Periodical extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract { /** * The subject matter of the content. diff --git a/src/PoliceStation.php b/src/PoliceStation.php index 6065b85e7..67eb809db 100644 --- a/src/PoliceStation.php +++ b/src/PoliceStation.php @@ -4,10 +4,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; -use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; -use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; /** * A police station. @@ -15,7 +15,7 @@ * @see http://schema.org/PoliceStation * */ -class PoliceStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class PoliceStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/RadioSeries.php b/src/RadioSeries.php index 857035c86..922b99ccf 100644 --- a/src/RadioSeries.php +++ b/src/RadioSeries.php @@ -5,8 +5,8 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * CreativeWorkSeries dedicated to radio broadcast and associated online @@ -15,7 +15,7 @@ * @see http://schema.org/RadioSeries * */ -class RadioSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract +class RadioSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract { /** * The subject matter of the content. diff --git a/src/StadiumOrArena.php b/src/StadiumOrArena.php index b1b0366b6..b42d77078 100644 --- a/src/StadiumOrArena.php +++ b/src/StadiumOrArena.php @@ -4,10 +4,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; -use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; -use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; /** * A stadium. @@ -15,7 +15,7 @@ * @see http://schema.org/StadiumOrArena * */ -class StadiumOrArena extends BaseType implements CivicStructureContract, SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class StadiumOrArena extends BaseType implements CivicStructureContract, SportsActivityLocationContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/TVSeason.php b/src/TVSeason.php index 4f5186e90..71cc45a70 100644 --- a/src/TVSeason.php +++ b/src/TVSeason.php @@ -4,7 +4,6 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkSeasonContract; -use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +12,7 @@ * @see http://schema.org/TVSeason * */ -class TVSeason extends BaseType implements CreativeWorkContract, CreativeWorkSeasonContract, CreativeWorkContract, ThingContract +class TVSeason extends BaseType implements CreativeWorkContract, CreativeWorkSeasonContract, ThingContract { /** * The subject matter of the content. diff --git a/src/TVSeries.php b/src/TVSeries.php index 7faf2a9ed..7fe57089c 100644 --- a/src/TVSeries.php +++ b/src/TVSeries.php @@ -4,10 +4,9 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; -use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; -use \Spatie\SchemaOrg\Contracts\ThingContract; /** * CreativeWorkSeries dedicated to TV broadcast and associated online delivery. @@ -15,7 +14,7 @@ * @see http://schema.org/TVSeries * */ -class TVSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract +class TVSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, ThingContract, SeriesContract, IntangibleContract { /** * The subject matter of the content. diff --git a/src/VideoGameSeries.php b/src/VideoGameSeries.php index 2a1f11cbe..2f48a4cb3 100644 --- a/src/VideoGameSeries.php +++ b/src/VideoGameSeries.php @@ -5,8 +5,8 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A video game series. @@ -14,7 +14,7 @@ * @see http://schema.org/VideoGameSeries * */ -class VideoGameSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, IntangibleContract, ThingContract +class VideoGameSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract { /** * The subject matter of the content. From 10f3d6e1f51732f37d3e23f807374a02388f784f Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 14:52:09 +0200 Subject: [PATCH 11/13] sort by value not key --- generator/Type.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generator/Type.php b/generator/Type.php index e41a87339..1f1e2748a 100644 --- a/generator/Type.php +++ b/generator/Type.php @@ -64,7 +64,7 @@ public function setTypeCollection(TypeCollection $typeCollection): void $this->parents = array_unique(array_merge($this->parents, $parent->parents)); - ksort($this->parents); + sort($this->parents); foreach ($parent->properties as $property) { $this->addProperty($property); From 9fc1a6a117522aa3303a3ed4a93d3cb06178c3d3 Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Tue, 17 Sep 2019 14:52:18 +0200 Subject: [PATCH 12/13] generated files --- src/AMRadioChannel.php | 4 ++-- src/APIReference.php | 4 ++-- src/AboutPage.php | 4 ++-- src/AcceptAction.php | 4 ++-- src/ActivateAction.php | 4 ++-- src/AddAction.php | 4 ++-- src/AggregateOffer.php | 4 ++-- src/AggregateRating.php | 4 ++-- src/AgreeAction.php | 6 +++--- src/AllocateAction.php | 4 ++-- src/ApartmentComplex.php | 4 ++-- src/AppendAction.php | 8 ++++---- src/ApplyAction.php | 4 ++-- src/ArriveAction.php | 4 ++-- src/AskAction.php | 4 ++-- src/AssignAction.php | 4 ++-- src/AudioObject.php | 4 ++-- src/AuthorizeAction.php | 4 ++-- src/AutoPartsStore.php | 4 ++-- src/BankAccount.php | 4 ++-- src/Barcode.php | 4 ++-- src/BedAndBreakfast.php | 4 ++-- src/BedType.php | 4 ++-- src/BefriendAction.php | 4 ++-- src/BikeStore.php | 4 ++-- src/BlogPosting.php | 4 ++-- src/BookSeries.php | 6 +++--- src/BookStore.php | 4 ++-- src/BookmarkAction.php | 4 ++-- src/BorrowAction.php | 4 ++-- src/BowlingAlley.php | 4 ++-- src/BreadcrumbList.php | 4 ++-- src/BroadcastEvent.php | 4 ++-- src/BroadcastService.php | 4 ++-- src/BuddhistTemple.php | 4 ++-- src/BusReservation.php | 4 ++-- src/BusTrip.php | 4 ++-- src/BuyAction.php | 4 ++-- src/CableOrSatelliteService.php | 4 ++-- src/Campground.php | 6 +++--- src/CancelAction.php | 6 +++--- src/Car.php | 4 ++-- src/CatholicChurch.php | 4 ++-- src/CheckAction.php | 4 ++-- src/CheckInAction.php | 4 ++-- src/CheckOutAction.php | 4 ++-- src/CheckoutPage.php | 4 ++-- src/ChooseAction.php | 4 ++-- src/Church.php | 4 ++-- src/CityHall.php | 4 ++-- src/ClaimReview.php | 4 ++-- src/ClothingStore.php | 4 ++-- src/CollectionPage.php | 4 ++-- src/CommentAction.php | 4 ++-- src/CommunicateAction.php | 4 ++-- src/CompoundPriceSpecification.php | 4 ++-- src/ComputerStore.php | 4 ++-- src/ConfirmAction.php | 6 +++--- src/ContactPage.php | 4 ++-- src/ContactPoint.php | 4 ++-- src/ConvenienceStore.php | 4 ++-- src/CookAction.php | 4 ++-- src/Courthouse.php | 4 ++-- src/CreativeWorkSeries.php | 4 ++-- src/CreditCard.php | 10 +++++----- src/CurrencyConversionService.php | 4 ++-- src/DanceGroup.php | 4 ++-- src/DataDownload.php | 4 ++-- src/DataFeed.php | 4 ++-- src/DatedMoneySpecification.php | 4 ++-- src/DeactivateAction.php | 4 ++-- src/DefenceEstablishment.php | 4 ++-- src/DeleteAction.php | 4 ++-- src/DeliveryChargeSpecification.php | 4 ++-- src/Dentist.php | 6 +++--- src/DepartAction.php | 4 ++-- src/DepartmentStore.php | 4 ++-- src/DepositAccount.php | 6 +++--- src/DisagreeAction.php | 6 +++--- src/DiscoverAction.php | 4 ++-- src/DiscussionForumPosting.php | 4 ++-- src/DislikeAction.php | 6 +++--- src/Distance.php | 4 ++-- src/DonateAction.php | 4 ++-- src/DownloadAction.php | 4 ++-- src/DrawAction.php | 4 ++-- src/DrinkAction.php | 4 ++-- src/DriveWheelConfigurationValue.php | 4 ++-- src/Duration.php | 4 ++-- src/EatAction.php | 4 ++-- src/ElectronicsStore.php | 4 ++-- src/EmailMessage.php | 4 ++-- src/Embassy.php | 4 ++-- src/EmployeeRole.php | 4 ++-- src/EmployerAggregateRating.php | 4 ++-- src/EndorseAction.php | 6 +++--- src/EndorsementRating.php | 4 ++-- src/Energy.php | 4 ++-- src/EngineSpecification.php | 4 ++-- src/EventReservation.php | 4 ++-- src/ExerciseAction.php | 4 ++-- src/ExerciseGym.php | 4 ++-- src/FAQPage.php | 4 ++-- src/FMRadioChannel.php | 4 ++-- src/FilmAction.php | 4 ++-- src/FinancialProduct.php | 4 ++-- src/FireStation.php | 6 +++--- src/Flight.php | 4 ++-- src/FlightReservation.php | 4 ++-- src/Florist.php | 4 ++-- src/FollowAction.php | 4 ++-- src/FoodEstablishmentReservation.php | 4 ++-- src/FoodService.php | 4 ++-- src/FurnitureStore.php | 4 ++-- src/GardenStore.php | 4 ++-- src/GatedResidenceCommunity.php | 4 ++-- src/GeoCircle.php | 4 ++-- src/GeoCoordinates.php | 4 ++-- src/GeoShape.php | 4 ++-- src/GiveAction.php | 4 ++-- src/GolfCourse.php | 4 ++-- src/GovernmentPermit.php | 4 ++-- src/GovernmentService.php | 4 ++-- src/GroceryStore.php | 4 ++-- src/HardwareStore.php | 4 ++-- src/HealthClub.php | 4 ++-- src/HinduTemple.php | 4 ++-- src/HobbyShop.php | 4 ++-- src/HomeGoodsStore.php | 4 ++-- src/Hospital.php | 6 +++--- src/Hostel.php | 4 ++-- src/Hotel.php | 4 ++-- src/HotelRoom.php | 4 ++-- src/HowToDirection.php | 4 ++-- src/HowToItem.php | 4 ++-- src/HowToSection.php | 6 +++--- src/HowToStep.php | 6 +++--- src/HowToSupply.php | 4 ++-- src/HowToTip.php | 4 ++-- src/HowToTool.php | 4 ++-- src/IgnoreAction.php | 4 ++-- src/ImageGallery.php | 4 ++-- src/ImageObject.php | 4 ++-- src/InformAction.php | 4 ++-- src/InsertAction.php | 6 +++--- src/InstallAction.php | 4 ++-- src/InteractionCounter.php | 4 ++-- src/InvestmentOrDeposit.php | 4 ++-- src/InviteAction.php | 4 ++-- src/ItemPage.php | 4 ++-- src/JewelryStore.php | 4 ++-- src/JoinAction.php | 4 ++-- src/LeaveAction.php | 4 ++-- src/LegislativeBuilding.php | 4 ++-- src/LendAction.php | 4 ++-- src/LikeAction.php | 6 +++--- src/LiquorStore.php | 4 ++-- src/ListenAction.php | 4 ++-- src/LiveBlogPosting.php | 6 +++--- src/LoanOrCredit.php | 4 ++-- src/LocationFeatureSpecification.php | 4 ++-- src/LodgingReservation.php | 4 ++-- src/MarryAction.php | 4 ++-- src/Mass.php | 4 ++-- src/MeetingRoom.php | 4 ++-- src/MensClothingStore.php | 4 ++-- src/MobileApplication.php | 4 ++-- src/MobilePhoneStore.php | 4 ++-- src/MonetaryAmount.php | 4 ++-- src/MonetaryAmountDistribution.php | 4 ++-- src/Mosque.php | 4 ++-- src/Motel.php | 4 ++-- src/MovieRentalStore.php | 4 ++-- src/MovieSeries.php | 6 +++--- src/MovieTheater.php | 6 +++--- src/MusicAlbum.php | 4 ++-- src/MusicGroup.php | 4 ++-- src/MusicRelease.php | 4 ++-- src/MusicStore.php | 4 ++-- src/MusicVideoObject.php | 4 ++-- src/NoteDigitalDocument.php | 4 ++-- src/NutritionInformation.php | 4 ++-- src/OfferCatalog.php | 4 ++-- src/OfficeEquipmentStore.php | 4 ++-- src/OnDemandEvent.php | 4 ++-- src/OpeningHoursSpecification.php | 4 ++-- src/OrderAction.php | 4 ++-- src/OrganizationRole.php | 4 ++-- src/OutletStore.php | 4 ++-- src/OwnershipInfo.php | 4 ++-- src/PaintAction.php | 4 ++-- src/ParentAudience.php | 4 ++-- src/PawnShop.php | 4 ++-- src/PayAction.php | 4 ++-- src/PaymentCard.php | 6 +++--- src/PaymentChargeSpecification.php | 4 ++-- src/PaymentService.php | 4 ++-- src/PerformAction.php | 4 ++-- src/PerformanceRole.php | 4 ++-- src/Periodical.php | 6 +++--- src/PetStore.php | 4 ++-- src/PhotographAction.php | 4 ++-- src/PlanAction.php | 4 ++-- src/PoliceStation.php | 6 +++--- src/PostalAddress.php | 4 ++-- src/PreOrderAction.php | 4 ++-- src/PrependAction.php | 8 ++++---- src/PresentationDigitalDocument.php | 4 ++-- src/PriceSpecification.php | 4 ++-- src/ProfilePage.php | 4 ++-- src/PropertyValue.php | 4 ++-- src/PublicSwimmingPool.php | 4 ++-- src/QAPage.php | 4 ++-- src/QuantitativeValue.php | 4 ++-- src/QuantitativeValueDistribution.php | 4 ++-- src/QuoteAction.php | 4 ++-- src/RadioEpisode.php | 4 ++-- src/RadioSeason.php | 4 ++-- src/RadioSeries.php | 6 +++--- src/ReactAction.php | 4 ++-- src/ReadAction.php | 4 ++-- src/ReceiveAction.php | 4 ++-- src/Recipe.php | 4 ++-- src/RegisterAction.php | 4 ++-- src/RejectAction.php | 4 ++-- src/RentAction.php | 4 ++-- src/RentalCarReservation.php | 4 ++-- src/ReplaceAction.php | 4 ++-- src/ReplyAction.php | 4 ++-- src/ReservationPackage.php | 4 ++-- src/ReserveAction.php | 6 +++--- src/Resort.php | 4 ++-- src/ResumeAction.php | 4 ++-- src/ReturnAction.php | 4 ++-- src/ReviewAction.php | 4 ++-- src/RsvpAction.php | 6 +++--- src/ScheduleAction.php | 6 +++--- src/SearchResultsPage.php | 4 ++-- src/SellAction.php | 4 ++-- src/SendAction.php | 4 ++-- src/ShareAction.php | 4 ++-- src/ShoeStore.php | 4 ++-- src/SingleFamilyResidence.php | 4 ++-- src/SiteNavigationElement.php | 4 ++-- src/SkiResort.php | 4 ++-- src/SportingGoodsStore.php | 4 ++-- src/SportsClub.php | 4 ++-- src/SportsTeam.php | 4 ++-- src/SpreadsheetDigitalDocument.php | 4 ++-- src/StadiumOrArena.php | 8 ++++---- src/SteeringPositionValue.php | 4 ++-- src/SubscribeAction.php | 4 ++-- src/SuspendAction.php | 4 ++-- src/Synagogue.php | 4 ++-- src/TVEpisode.php | 4 ++-- src/TVSeries.php | 6 +++--- src/Table.php | 4 ++-- src/TakeAction.php | 4 ++-- src/Taxi.php | 4 ++-- src/TaxiReservation.php | 4 ++-- src/TaxiService.php | 4 ++-- src/TennisComplex.php | 4 ++-- src/TextDigitalDocument.php | 4 ++-- src/TheaterGroup.php | 4 ++-- src/TipAction.php | 4 ++-- src/TireShop.php | 4 ++-- src/ToyStore.php | 4 ++-- src/TrackAction.php | 4 ++-- src/TrainReservation.php | 4 ++-- src/TrainTrip.php | 4 ++-- src/TravelAction.php | 4 ++-- src/TypeAndQuantityNode.php | 4 ++-- src/UnRegisterAction.php | 4 ++-- src/UnitPriceSpecification.php | 4 ++-- src/UseAction.php | 4 ++-- src/UserBlocks.php | 4 ++-- src/UserCheckins.php | 4 ++-- src/UserComments.php | 4 ++-- src/UserDownloads.php | 4 ++-- src/UserLikes.php | 4 ++-- src/UserPageVisits.php | 4 ++-- src/UserPlays.php | 4 ++-- src/UserPlusOnes.php | 4 ++-- src/UserTweets.php | 4 ++-- src/VideoGallery.php | 4 ++-- src/VideoGame.php | 6 +++--- src/VideoGameSeries.php | 6 +++--- src/VideoObject.php | 4 ++-- src/ViewAction.php | 4 ++-- src/VoteAction.php | 6 +++--- src/WPAdBlock.php | 4 ++-- src/WPFooter.php | 4 ++-- src/WPHeader.php | 4 ++-- src/WPSideBar.php | 4 ++-- src/WantAction.php | 6 +++--- src/WarrantyPromise.php | 4 ++-- src/WatchAction.php | 4 ++-- src/WearAction.php | 6 +++--- src/WebApplication.php | 4 ++-- src/WholesaleStore.php | 4 ++-- src/WriteAction.php | 4 ++-- 301 files changed, 643 insertions(+), 643 deletions(-) diff --git a/src/AMRadioChannel.php b/src/AMRadioChannel.php index d9f908775..40e8eb0c5 100644 --- a/src/AMRadioChannel.php +++ b/src/AMRadioChannel.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\RadioChannelContract; use \Spatie\SchemaOrg\Contracts\BroadcastChannelContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\RadioChannelContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/AMRadioChannel * */ -class AMRadioChannel extends BaseType implements RadioChannelContract, BroadcastChannelContract, IntangibleContract, ThingContract +class AMRadioChannel extends BaseType implements BroadcastChannelContract, IntangibleContract, RadioChannelContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/APIReference.php b/src/APIReference.php index e1f970fd2..5378c2887 100644 --- a/src/APIReference.php +++ b/src/APIReference.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TechArticleContract; use \Spatie\SchemaOrg\Contracts\ArticleContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\TechArticleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/APIReference * */ -class APIReference extends BaseType implements TechArticleContract, ArticleContract, CreativeWorkContract, ThingContract +class APIReference extends BaseType implements ArticleContract, CreativeWorkContract, TechArticleContract, ThingContract { /** * The subject matter of the content. diff --git a/src/AboutPage.php b/src/AboutPage.php index 503ae4ce1..d02b6f243 100644 --- a/src/AboutPage.php +++ b/src/AboutPage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * Web page type: About page. @@ -12,7 +12,7 @@ * @see http://schema.org/AboutPage * */ -class AboutPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class AboutPage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/AcceptAction.php b/src/AcceptAction.php index ab6154ad1..acd90b640 100644 --- a/src/AcceptAction.php +++ b/src/AcceptAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\AllocateActionContract; use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -17,7 +17,7 @@ * @see http://schema.org/AcceptAction * */ -class AcceptAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract +class AcceptAction extends BaseType implements ActionContract, AllocateActionContract, OrganizeActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/ActivateAction.php b/src/ActivateAction.php index debecc9cc..f239682f7 100644 --- a/src/ActivateAction.php +++ b/src/ActivateAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ControlActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ControlActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ActivateAction * */ -class ActivateAction extends BaseType implements ControlActionContract, ActionContract, ThingContract +class ActivateAction extends BaseType implements ActionContract, ControlActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/AddAction.php b/src/AddAction.php index a01e04a36..60a32c3f6 100644 --- a/src/AddAction.php +++ b/src/AddAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UpdateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; /** * The act of editing by adding an object to a collection. @@ -12,7 +12,7 @@ * @see http://schema.org/AddAction * */ -class AddAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract +class AddAction extends BaseType implements ActionContract, ThingContract, UpdateActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/AggregateOffer.php b/src/AggregateOffer.php index 0e334299d..07c86bb2c 100644 --- a/src/AggregateOffer.php +++ b/src/AggregateOffer.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\OfferContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\OfferContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/AggregateOffer * */ -class AggregateOffer extends BaseType implements OfferContract, IntangibleContract, ThingContract +class AggregateOffer extends BaseType implements IntangibleContract, OfferContract, ThingContract { /** * The payment method(s) accepted by seller for this offer. diff --git a/src/AggregateRating.php b/src/AggregateRating.php index 2afa68d5b..644d63b77 100644 --- a/src/AggregateRating.php +++ b/src/AggregateRating.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\RatingContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\RatingContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/AggregateRating * */ -class AggregateRating extends BaseType implements RatingContract, IntangibleContract, ThingContract +class AggregateRating extends BaseType implements IntangibleContract, RatingContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/AgreeAction.php b/src/AgreeAction.php index 8b5b29f89..c625298be 100644 --- a/src/AgreeAction.php +++ b/src/AgreeAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReactActionContract; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/AgreeAction * */ -class AgreeAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract +class AgreeAction extends BaseType implements ActionContract, AssessActionContract, ReactActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/AllocateAction.php b/src/AllocateAction.php index 0c05be0b7..e930f1b54 100644 --- a/src/AllocateAction.php +++ b/src/AllocateAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/AllocateAction * */ -class AllocateAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract +class AllocateAction extends BaseType implements ActionContract, OrganizeActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/ApartmentComplex.php b/src/ApartmentComplex.php index 025ed57d0..5e7b79206 100644 --- a/src/ApartmentComplex.php +++ b/src/ApartmentComplex.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ResidenceContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ResidenceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/ApartmentComplex * */ -class ApartmentComplex extends BaseType implements ResidenceContract, PlaceContract, ThingContract +class ApartmentComplex extends BaseType implements PlaceContract, ResidenceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/AppendAction.php b/src/AppendAction.php index b741a97bb..6498eed2f 100644 --- a/src/AppendAction.php +++ b/src/AppendAction.php @@ -2,11 +2,11 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InsertActionContract; -use \Spatie\SchemaOrg\Contracts\AddActionContract; -use \Spatie\SchemaOrg\Contracts\UpdateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AddActionContract; +use \Spatie\SchemaOrg\Contracts\InsertActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; /** * The act of inserting at the end if an ordered collection. @@ -14,7 +14,7 @@ * @see http://schema.org/AppendAction * */ -class AppendAction extends BaseType implements InsertActionContract, AddActionContract, UpdateActionContract, ActionContract, ThingContract +class AppendAction extends BaseType implements ActionContract, AddActionContract, InsertActionContract, ThingContract, UpdateActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/ApplyAction.php b/src/ApplyAction.php index e6a43ed51..d1f0991f5 100644 --- a/src/ApplyAction.php +++ b/src/ApplyAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -18,7 +18,7 @@ * @see http://schema.org/ApplyAction * */ -class ApplyAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract +class ApplyAction extends BaseType implements ActionContract, OrganizeActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/ArriveAction.php b/src/ArriveAction.php index 62dd4f1f4..ac41834d1 100644 --- a/src/ArriveAction.php +++ b/src/ArriveAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MoveActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\MoveActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ArriveAction * */ -class ArriveAction extends BaseType implements MoveActionContract, ActionContract, ThingContract +class ArriveAction extends BaseType implements ActionContract, MoveActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/AskAction.php b/src/AskAction.php index 9a670628a..f7eceb1c9 100644 --- a/src/AskAction.php +++ b/src/AskAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -17,7 +17,7 @@ * @see http://schema.org/AskAction * */ -class AskAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class AskAction extends BaseType implements ActionContract, CommunicateActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/AssignAction.php b/src/AssignAction.php index e2025e9ca..8ec721f4d 100644 --- a/src/AssignAction.php +++ b/src/AssignAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\AllocateActionContract; use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/AssignAction * */ -class AssignAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract +class AssignAction extends BaseType implements ActionContract, AllocateActionContract, OrganizeActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/AudioObject.php b/src/AudioObject.php index dd7aefaa2..7e396fd6d 100644 --- a/src/AudioObject.php +++ b/src/AudioObject.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/AudioObject * */ -class AudioObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract +class AudioObject extends BaseType implements CreativeWorkContract, MediaObjectContract, ThingContract { /** * The subject matter of the content. diff --git a/src/AuthorizeAction.php b/src/AuthorizeAction.php index 9b6936421..0e9876107 100644 --- a/src/AuthorizeAction.php +++ b/src/AuthorizeAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\AllocateActionContract; use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/AuthorizeAction * */ -class AuthorizeAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract +class AuthorizeAction extends BaseType implements ActionContract, AllocateActionContract, OrganizeActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/AutoPartsStore.php b/src/AutoPartsStore.php index d6c8dec5b..0c14ba45b 100644 --- a/src/AutoPartsStore.php +++ b/src/AutoPartsStore.php @@ -3,10 +3,10 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\AutomotiveBusinessContract; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/AutoPartsStore * */ -class AutoPartsStore extends BaseType implements AutomotiveBusinessContract, StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class AutoPartsStore extends BaseType implements AutomotiveBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/BankAccount.php b/src/BankAccount.php index 6a013b6a9..010d32f59 100644 --- a/src/BankAccount.php +++ b/src/BankAccount.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/BankAccount * */ -class BankAccount extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract +class BankAccount extends BaseType implements FinancialProductContract, IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Barcode.php b/src/Barcode.php index e5318b856..3644e94f2 100644 --- a/src/Barcode.php +++ b/src/Barcode.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ImageObjectContract; use \Spatie\SchemaOrg\Contracts\MediaObjectContract; -use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/Barcode * */ -class Barcode extends BaseType implements ImageObjectContract, MediaObjectContract, CreativeWorkContract, ThingContract +class Barcode extends BaseType implements CreativeWorkContract, ImageObjectContract, MediaObjectContract, ThingContract { /** * The subject matter of the content. diff --git a/src/BedAndBreakfast.php b/src/BedAndBreakfast.php index 55d979a08..02b2936a4 100644 --- a/src/BedAndBreakfast.php +++ b/src/BedAndBreakfast.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -17,7 +17,7 @@ * @see http://schema.org/BedAndBreakfast * */ -class BedAndBreakfast extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class BedAndBreakfast extends BaseType implements LocalBusinessContract, LodgingBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/BedType.php b/src/BedType.php index 80dc699a5..b8a8d77c2 100644 --- a/src/BedType.php +++ b/src/BedType.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; use \Spatie\SchemaOrg\Contracts\EnumerationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/BedType * */ -class BedType extends BaseType implements QualitativeValueContract, EnumerationContract, IntangibleContract, ThingContract +class BedType extends BaseType implements EnumerationContract, IntangibleContract, QualitativeValueContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/BefriendAction.php b/src/BefriendAction.php index e17e5971d..801f3fd68 100644 --- a/src/BefriendAction.php +++ b/src/BefriendAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -18,7 +18,7 @@ * @see http://schema.org/BefriendAction * */ -class BefriendAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class BefriendAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/BikeStore.php b/src/BikeStore.php index 2ba08cf78..9f66b1e3a 100644 --- a/src/BikeStore.php +++ b/src/BikeStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/BikeStore * */ -class BikeStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class BikeStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/BlogPosting.php b/src/BlogPosting.php index 21f793c34..116c05d9e 100644 --- a/src/BlogPosting.php +++ b/src/BlogPosting.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; use \Spatie\SchemaOrg\Contracts\ArticleContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/BlogPosting * */ -class BlogPosting extends BaseType implements SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract +class BlogPosting extends BaseType implements ArticleContract, CreativeWorkContract, SocialMediaPostingContract, ThingContract { /** * The subject matter of the content. diff --git a/src/BookSeries.php b/src/BookSeries.php index 75ecec583..bfe630735 100644 --- a/src/BookSeries.php +++ b/src/BookSeries.php @@ -2,11 +2,11 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A series of books. Included books can be indicated with the hasPart property. @@ -14,7 +14,7 @@ * @see http://schema.org/BookSeries * */ -class BookSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract +class BookSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, IntangibleContract, SeriesContract, ThingContract { /** * The subject matter of the content. diff --git a/src/BookStore.php b/src/BookStore.php index 88482d79b..d6437378a 100644 --- a/src/BookStore.php +++ b/src/BookStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/BookStore * */ -class BookStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class BookStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/BookmarkAction.php b/src/BookmarkAction.php index bd2a73253..0cb82cabd 100644 --- a/src/BookmarkAction.php +++ b/src/BookmarkAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/BookmarkAction * */ -class BookmarkAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract +class BookmarkAction extends BaseType implements ActionContract, OrganizeActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/BorrowAction.php b/src/BorrowAction.php index 00cc6785c..4682a8a70 100644 --- a/src/BorrowAction.php +++ b/src/BorrowAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TransferActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; /** * The act of obtaining an object under an agreement to return it at a later @@ -17,7 +17,7 @@ * @see http://schema.org/BorrowAction * */ -class BorrowAction extends BaseType implements TransferActionContract, ActionContract, ThingContract +class BorrowAction extends BaseType implements ActionContract, ThingContract, TransferActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/BowlingAlley.php b/src/BowlingAlley.php index abda4a913..9520400a7 100644 --- a/src/BowlingAlley.php +++ b/src/BowlingAlley.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/BowlingAlley * */ -class BowlingAlley extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class BowlingAlley extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/BreadcrumbList.php b/src/BreadcrumbList.php index c09eb57ff..80f9d2e92 100644 --- a/src/BreadcrumbList.php +++ b/src/BreadcrumbList.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ItemListContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ItemListContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -22,7 +22,7 @@ * @see http://schema.org/BreadcrumbList * */ -class BreadcrumbList extends BaseType implements ItemListContract, IntangibleContract, ThingContract +class BreadcrumbList extends BaseType implements IntangibleContract, ItemListContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/BroadcastEvent.php b/src/BroadcastEvent.php index ad5a447cf..d74b9889e 100644 --- a/src/BroadcastEvent.php +++ b/src/BroadcastEvent.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PublicationEventContract; use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\PublicationEventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/BroadcastEvent * */ -class BroadcastEvent extends BaseType implements PublicationEventContract, EventContract, ThingContract +class BroadcastEvent extends BaseType implements EventContract, PublicationEventContract, ThingContract { /** * The subject matter of the content. diff --git a/src/BroadcastService.php b/src/BroadcastService.php index 7102b533c..f5d727ea8 100644 --- a/src/BroadcastService.php +++ b/src/BroadcastService.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/BroadcastService * */ -class BroadcastService extends BaseType implements ServiceContract, IntangibleContract, ThingContract +class BroadcastService extends BaseType implements IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/BuddhistTemple.php b/src/BuddhistTemple.php index cc877105a..de4843d39 100644 --- a/src/BuddhistTemple.php +++ b/src/BuddhistTemple.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/BuddhistTemple * */ -class BuddhistTemple extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract +class BuddhistTemple extends BaseType implements CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/BusReservation.php b/src/BusReservation.php index 68c9e467d..f4a415dad 100644 --- a/src/BusReservation.php +++ b/src/BusReservation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/BusReservation * */ -class BusReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class BusReservation extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/BusTrip.php b/src/BusTrip.php index fab35ef70..957ea95b7 100644 --- a/src/BusTrip.php +++ b/src/BusTrip.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TripContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TripContract; /** * A trip on a commercial bus line. @@ -12,7 +12,7 @@ * @see http://schema.org/BusTrip * */ -class BusTrip extends BaseType implements TripContract, IntangibleContract, ThingContract +class BusTrip extends BaseType implements IntangibleContract, ThingContract, TripContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/BuyAction.php b/src/BuyAction.php index 7a4b57b2c..f25121660 100644 --- a/src/BuyAction.php +++ b/src/BuyAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * The act of giving money to a seller in exchange for goods or services @@ -14,7 +14,7 @@ * @see http://schema.org/BuyAction * */ -class BuyAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class BuyAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/CableOrSatelliteService.php b/src/CableOrSatelliteService.php index 49e760b4e..60e509c84 100644 --- a/src/CableOrSatelliteService.php +++ b/src/CableOrSatelliteService.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/CableOrSatelliteService * */ -class CableOrSatelliteService extends BaseType implements ServiceContract, IntangibleContract, ThingContract +class CableOrSatelliteService extends BaseType implements IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Campground.php b/src/Campground.php index 6b0abf0df..dc7f8143b 100644 --- a/src/Campground.php +++ b/src/Campground.php @@ -3,11 +3,11 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; -use \Spatie\SchemaOrg\Contracts\OrganizationContract; /** * A camping site, campsite, or [[Campground]] is a place used for overnight @@ -32,7 +32,7 @@ * @see http://schema.org/Campground * */ -class Campground extends BaseType implements CivicStructureContract, LodgingBusinessContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract +class Campground extends BaseType implements CivicStructureContract, LocalBusinessContract, LodgingBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/CancelAction.php b/src/CancelAction.php index c867582cd..476ad7632 100644 --- a/src/CancelAction.php +++ b/src/CancelAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlanActionContract; -use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\PlanActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -17,7 +17,7 @@ * @see http://schema.org/CancelAction * */ -class CancelAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract +class CancelAction extends BaseType implements ActionContract, OrganizeActionContract, PlanActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/Car.php b/src/Car.php index 07a070435..8587ad785 100644 --- a/src/Car.php +++ b/src/Car.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\VehicleContract; use \Spatie\SchemaOrg\Contracts\ProductContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\VehicleContract; /** * A car is a wheeled, self-powered motor vehicle used for transportation. @@ -12,7 +12,7 @@ * @see http://schema.org/Car * */ -class Car extends BaseType implements VehicleContract, ProductContract, ThingContract +class Car extends BaseType implements ProductContract, ThingContract, VehicleContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/CatholicChurch.php b/src/CatholicChurch.php index 7ce9f7cfe..df1c4b339 100644 --- a/src/CatholicChurch.php +++ b/src/CatholicChurch.php @@ -3,9 +3,9 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\ChurchContract; -use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/CatholicChurch * */ -class CatholicChurch extends BaseType implements ChurchContract, PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract +class CatholicChurch extends BaseType implements ChurchContract, CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/CheckAction.php b/src/CheckAction.php index 8952c5983..3771c7abd 100644 --- a/src/CheckAction.php +++ b/src/CheckAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\FindActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\FindActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/CheckAction * */ -class CheckAction extends BaseType implements FindActionContract, ActionContract, ThingContract +class CheckAction extends BaseType implements ActionContract, FindActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/CheckInAction.php b/src/CheckInAction.php index 3c1362948..2e260dfed 100644 --- a/src/CheckInAction.php +++ b/src/CheckInAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -25,7 +25,7 @@ * @see http://schema.org/CheckInAction * */ -class CheckInAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class CheckInAction extends BaseType implements ActionContract, CommunicateActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/CheckOutAction.php b/src/CheckOutAction.php index da1fe8bce..752c24a96 100644 --- a/src/CheckOutAction.php +++ b/src/CheckOutAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -23,7 +23,7 @@ * @see http://schema.org/CheckOutAction * */ -class CheckOutAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class CheckOutAction extends BaseType implements ActionContract, CommunicateActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/CheckoutPage.php b/src/CheckoutPage.php index d7d374b47..f30c50a0e 100644 --- a/src/CheckoutPage.php +++ b/src/CheckoutPage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * Web page type: Checkout page. @@ -12,7 +12,7 @@ * @see http://schema.org/CheckoutPage * */ -class CheckoutPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class CheckoutPage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/ChooseAction.php b/src/ChooseAction.php index fbf865270..ade9dc0a3 100644 --- a/src/ChooseAction.php +++ b/src/ChooseAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ChooseAction * */ -class ChooseAction extends BaseType implements AssessActionContract, ActionContract, ThingContract +class ChooseAction extends BaseType implements ActionContract, AssessActionContract, ThingContract { /** * A sub property of object. The options subject to this action. diff --git a/src/Church.php b/src/Church.php index 97f6db43d..afcc36019 100644 --- a/src/Church.php +++ b/src/Church.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/Church * */ -class Church extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract +class Church extends BaseType implements CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/CityHall.php b/src/CityHall.php index 8d658bfcd..759725245 100644 --- a/src/CityHall.php +++ b/src/CityHall.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -13,7 +13,7 @@ * @see http://schema.org/CityHall * */ -class CityHall extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract +class CityHall extends BaseType implements CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/ClaimReview.php b/src/ClaimReview.php index 7a8853e77..16a6ed007 100644 --- a/src/ClaimReview.php +++ b/src/ClaimReview.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReviewContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\ReviewContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ClaimReview * */ -class ClaimReview extends BaseType implements ReviewContract, CreativeWorkContract, ThingContract +class ClaimReview extends BaseType implements CreativeWorkContract, ReviewContract, ThingContract { /** * The subject matter of the content. diff --git a/src/ClothingStore.php b/src/ClothingStore.php index 8d5261557..7c0b20972 100644 --- a/src/ClothingStore.php +++ b/src/ClothingStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/ClothingStore * */ -class ClothingStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class ClothingStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/CollectionPage.php b/src/CollectionPage.php index e32f8e2e5..ad129efdc 100644 --- a/src/CollectionPage.php +++ b/src/CollectionPage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * Web page type: Collection page. @@ -12,7 +12,7 @@ * @see http://schema.org/CollectionPage * */ -class CollectionPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class CollectionPage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/CommentAction.php b/src/CommentAction.php index aeb77ce1b..b08cba906 100644 --- a/src/CommentAction.php +++ b/src/CommentAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/CommentAction * */ -class CommentAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class CommentAction extends BaseType implements ActionContract, CommunicateActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/CommunicateAction.php b/src/CommunicateAction.php index ef4a1f033..031ccd064 100644 --- a/src/CommunicateAction.php +++ b/src/CommunicateAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/CommunicateAction * */ -class CommunicateAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class CommunicateAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/CompoundPriceSpecification.php b/src/CompoundPriceSpecification.php index 4eb0a417c..4fd8d4b7c 100644 --- a/src/CompoundPriceSpecification.php +++ b/src/CompoundPriceSpecification.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\PriceSpecificationContract; use \Spatie\SchemaOrg\Contracts\StructuredValueContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/CompoundPriceSpecification * */ -class CompoundPriceSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract +class CompoundPriceSpecification extends BaseType implements IntangibleContract, PriceSpecificationContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/ComputerStore.php b/src/ComputerStore.php index 95ac75a2f..df1fae1a2 100644 --- a/src/ComputerStore.php +++ b/src/ComputerStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/ComputerStore * */ -class ComputerStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class ComputerStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/ConfirmAction.php b/src/ConfirmAction.php index c85e68909..6084ae895 100644 --- a/src/ConfirmAction.php +++ b/src/ConfirmAction.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InformActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InformActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -19,7 +19,7 @@ * @see http://schema.org/ConfirmAction * */ -class ConfirmAction extends BaseType implements InformActionContract, CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class ConfirmAction extends BaseType implements ActionContract, CommunicateActionContract, InformActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/ContactPage.php b/src/ContactPage.php index 31bf32b1e..e6da6464b 100644 --- a/src/ContactPage.php +++ b/src/ContactPage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * Web page type: Contact page. @@ -12,7 +12,7 @@ * @see http://schema.org/ContactPage * */ -class ContactPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class ContactPage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/ContactPoint.php b/src/ContactPoint.php index 5cd107a29..d505eeb59 100644 --- a/src/ContactPoint.php +++ b/src/ContactPoint.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/ContactPoint * */ -class ContactPoint extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class ContactPoint extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/ConvenienceStore.php b/src/ConvenienceStore.php index 284faad34..9e61de2e3 100644 --- a/src/ConvenienceStore.php +++ b/src/ConvenienceStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/ConvenienceStore * */ -class ConvenienceStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class ConvenienceStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/CookAction.php b/src/CookAction.php index 60512388f..0e0bed554 100644 --- a/src/CookAction.php +++ b/src/CookAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/CookAction * */ -class CookAction extends BaseType implements CreateActionContract, ActionContract, ThingContract +class CookAction extends BaseType implements ActionContract, CreateActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/Courthouse.php b/src/Courthouse.php index a33e73903..aa339ca3e 100644 --- a/src/Courthouse.php +++ b/src/Courthouse.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -13,7 +13,7 @@ * @see http://schema.org/Courthouse * */ -class Courthouse extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract +class Courthouse extends BaseType implements CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/CreativeWorkSeries.php b/src/CreativeWorkSeries.php index 2cbbb57f6..7e240457b 100644 --- a/src/CreativeWorkSeries.php +++ b/src/CreativeWorkSeries.php @@ -3,9 +3,9 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A CreativeWorkSeries in schema.org is a group of related items, typically but @@ -29,7 +29,7 @@ * @see http://schema.org/CreativeWorkSeries * */ -class CreativeWorkSeries extends BaseType implements CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract +class CreativeWorkSeries extends BaseType implements CreativeWorkContract, IntangibleContract, SeriesContract, ThingContract { /** * The subject matter of the content. diff --git a/src/CreditCard.php b/src/CreditCard.php index 17447a296..1117bb742 100644 --- a/src/CreditCard.php +++ b/src/CreditCard.php @@ -2,14 +2,14 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PaymentCardContract; -use \Spatie\SchemaOrg\Contracts\LoanOrCreditContract; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\LoanOrCreditContract; +use \Spatie\SchemaOrg\Contracts\PaymentCardContract; use \Spatie\SchemaOrg\Contracts\PaymentMethodContract; use \Spatie\SchemaOrg\Contracts\ServiceContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\EnumerationContract; /** * A card payment method of a particular brand or name. Used to mark up a @@ -28,7 +28,7 @@ * @see http://schema.org/CreditCard * */ -class CreditCard extends BaseType implements PaymentCardContract, LoanOrCreditContract, FinancialProductContract, PaymentMethodContract, ServiceContract, IntangibleContract, ThingContract, EnumerationContract +class CreditCard extends BaseType implements EnumerationContract, FinancialProductContract, IntangibleContract, LoanOrCreditContract, PaymentCardContract, PaymentMethodContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/CurrencyConversionService.php b/src/CurrencyConversionService.php index 7a5742ee2..6b2437889 100644 --- a/src/CurrencyConversionService.php +++ b/src/CurrencyConversionService.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/CurrencyConversionService * */ -class CurrencyConversionService extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract +class CurrencyConversionService extends BaseType implements FinancialProductContract, IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/DanceGroup.php b/src/DanceGroup.php index 360063000..3616545ae 100644 --- a/src/DanceGroup.php +++ b/src/DanceGroup.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/DanceGroup * */ -class DanceGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract +class DanceGroup extends BaseType implements OrganizationContract, PerformingGroupContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/DataDownload.php b/src/DataDownload.php index 729a82215..887191d2b 100644 --- a/src/DataDownload.php +++ b/src/DataDownload.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/DataDownload * */ -class DataDownload extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract +class DataDownload extends BaseType implements CreativeWorkContract, MediaObjectContract, ThingContract { /** * The subject matter of the content. diff --git a/src/DataFeed.php b/src/DataFeed.php index 48e3ba84d..a9fe853d2 100644 --- a/src/DataFeed.php +++ b/src/DataFeed.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\DatasetContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\DatasetContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/DataFeed * */ -class DataFeed extends BaseType implements DatasetContract, CreativeWorkContract, ThingContract +class DataFeed extends BaseType implements CreativeWorkContract, DatasetContract, ThingContract { /** * The subject matter of the content. diff --git a/src/DatedMoneySpecification.php b/src/DatedMoneySpecification.php index 0dce651d8..dbbf1fce4 100644 --- a/src/DatedMoneySpecification.php +++ b/src/DatedMoneySpecification.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/DatedMoneySpecification * */ -class DatedMoneySpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class DatedMoneySpecification extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/DeactivateAction.php b/src/DeactivateAction.php index fc45e5413..2c8f6b1fe 100644 --- a/src/DeactivateAction.php +++ b/src/DeactivateAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ControlActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ControlActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/DeactivateAction * */ -class DeactivateAction extends BaseType implements ControlActionContract, ActionContract, ThingContract +class DeactivateAction extends BaseType implements ActionContract, ControlActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/DefenceEstablishment.php b/src/DefenceEstablishment.php index 8c4623ccb..ca744ebfb 100644 --- a/src/DefenceEstablishment.php +++ b/src/DefenceEstablishment.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -13,7 +13,7 @@ * @see http://schema.org/DefenceEstablishment * */ -class DefenceEstablishment extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract +class DefenceEstablishment extends BaseType implements CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/DeleteAction.php b/src/DeleteAction.php index 31917e33c..3c0993336 100644 --- a/src/DeleteAction.php +++ b/src/DeleteAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UpdateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; /** * The act of editing a recipient by removing one of its objects. @@ -12,7 +12,7 @@ * @see http://schema.org/DeleteAction * */ -class DeleteAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract +class DeleteAction extends BaseType implements ActionContract, ThingContract, UpdateActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/DeliveryChargeSpecification.php b/src/DeliveryChargeSpecification.php index ee5f4367a..48e1a6264 100644 --- a/src/DeliveryChargeSpecification.php +++ b/src/DeliveryChargeSpecification.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\PriceSpecificationContract; use \Spatie\SchemaOrg\Contracts\StructuredValueContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/DeliveryChargeSpecification * */ -class DeliveryChargeSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract +class DeliveryChargeSpecification extends BaseType implements IntangibleContract, PriceSpecificationContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Dentist.php b/src/Dentist.php index 473489480..0fa77d941 100644 --- a/src/Dentist.php +++ b/src/Dentist.php @@ -2,11 +2,11 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; -use \Spatie\SchemaOrg\Contracts\ThingContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; /** * A dentist. @@ -14,7 +14,7 @@ * @see http://schema.org/Dentist * */ -class Dentist extends BaseType implements MedicalOrganizationContract, LocalBusinessContract, OrganizationContract, ThingContract, PlaceContract +class Dentist extends BaseType implements LocalBusinessContract, MedicalOrganizationContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/DepartAction.php b/src/DepartAction.php index 917f0f550..d097fd3bf 100644 --- a/src/DepartAction.php +++ b/src/DepartAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MoveActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\MoveActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/DepartAction * */ -class DepartAction extends BaseType implements MoveActionContract, ActionContract, ThingContract +class DepartAction extends BaseType implements ActionContract, MoveActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/DepartmentStore.php b/src/DepartmentStore.php index 9941ec29e..a141abbd5 100644 --- a/src/DepartmentStore.php +++ b/src/DepartmentStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/DepartmentStore * */ -class DepartmentStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class DepartmentStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/DepositAccount.php b/src/DepositAccount.php index 2672dac5b..6e759f036 100644 --- a/src/DepositAccount.php +++ b/src/DepositAccount.php @@ -3,10 +3,10 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\BankAccountContract; -use \Spatie\SchemaOrg\Contracts\InvestmentOrDepositContract; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\InvestmentOrDepositContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/DepositAccount * */ -class DepositAccount extends BaseType implements BankAccountContract, InvestmentOrDepositContract, FinancialProductContract, ServiceContract, IntangibleContract, ThingContract +class DepositAccount extends BaseType implements BankAccountContract, FinancialProductContract, IntangibleContract, InvestmentOrDepositContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/DisagreeAction.php b/src/DisagreeAction.php index ffb0ca073..58bb4464e 100644 --- a/src/DisagreeAction.php +++ b/src/DisagreeAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReactActionContract; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/DisagreeAction * */ -class DisagreeAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract +class DisagreeAction extends BaseType implements ActionContract, AssessActionContract, ReactActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/DiscoverAction.php b/src/DiscoverAction.php index d189e66cd..c62463537 100644 --- a/src/DiscoverAction.php +++ b/src/DiscoverAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\FindActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\FindActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/DiscoverAction * */ -class DiscoverAction extends BaseType implements FindActionContract, ActionContract, ThingContract +class DiscoverAction extends BaseType implements ActionContract, FindActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/DiscussionForumPosting.php b/src/DiscussionForumPosting.php index 40d057af9..427c7055e 100644 --- a/src/DiscussionForumPosting.php +++ b/src/DiscussionForumPosting.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; use \Spatie\SchemaOrg\Contracts\ArticleContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/DiscussionForumPosting * */ -class DiscussionForumPosting extends BaseType implements SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract +class DiscussionForumPosting extends BaseType implements ArticleContract, CreativeWorkContract, SocialMediaPostingContract, ThingContract { /** * The subject matter of the content. diff --git a/src/DislikeAction.php b/src/DislikeAction.php index c40bd3733..db0729bc0 100644 --- a/src/DislikeAction.php +++ b/src/DislikeAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReactActionContract; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/DislikeAction * */ -class DislikeAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract +class DislikeAction extends BaseType implements ActionContract, AssessActionContract, ReactActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/Distance.php b/src/Distance.php index 504e48189..dc6a3a37f 100644 --- a/src/Distance.php +++ b/src/Distance.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\QuantityContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\QuantityContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/Distance * */ -class Distance extends BaseType implements QuantityContract, IntangibleContract, ThingContract +class Distance extends BaseType implements IntangibleContract, QuantityContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/DonateAction.php b/src/DonateAction.php index 6ebdbe5d7..d167d3607 100644 --- a/src/DonateAction.php +++ b/src/DonateAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * The act of providing goods, services, or money without compensation, often @@ -13,7 +13,7 @@ * @see http://schema.org/DonateAction * */ -class DonateAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class DonateAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/DownloadAction.php b/src/DownloadAction.php index 19e9bb23c..081dfc73b 100644 --- a/src/DownloadAction.php +++ b/src/DownloadAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TransferActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; /** * The act of downloading an object. @@ -12,7 +12,7 @@ * @see http://schema.org/DownloadAction * */ -class DownloadAction extends BaseType implements TransferActionContract, ActionContract, ThingContract +class DownloadAction extends BaseType implements ActionContract, ThingContract, TransferActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/DrawAction.php b/src/DrawAction.php index 6b352698e..f3b4b03f9 100644 --- a/src/DrawAction.php +++ b/src/DrawAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/DrawAction * */ -class DrawAction extends BaseType implements CreateActionContract, ActionContract, ThingContract +class DrawAction extends BaseType implements ActionContract, CreateActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/DrinkAction.php b/src/DrinkAction.php index 1cbdea383..5b67a9624 100644 --- a/src/DrinkAction.php +++ b/src/DrinkAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/DrinkAction * */ -class DrinkAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract +class DrinkAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/DriveWheelConfigurationValue.php b/src/DriveWheelConfigurationValue.php index 4ff973940..a4158a11e 100644 --- a/src/DriveWheelConfigurationValue.php +++ b/src/DriveWheelConfigurationValue.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; use \Spatie\SchemaOrg\Contracts\EnumerationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/DriveWheelConfigurationValue * */ -class DriveWheelConfigurationValue extends BaseType implements QualitativeValueContract, EnumerationContract, IntangibleContract, ThingContract +class DriveWheelConfigurationValue extends BaseType implements EnumerationContract, IntangibleContract, QualitativeValueContract, ThingContract { /** * All-wheel Drive is a transmission layout where the engine drives all four diff --git a/src/Duration.php b/src/Duration.php index 8b325e16a..755d6a02d 100644 --- a/src/Duration.php +++ b/src/Duration.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\QuantityContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\QuantityContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/Duration * */ -class Duration extends BaseType implements QuantityContract, IntangibleContract, ThingContract +class Duration extends BaseType implements IntangibleContract, QuantityContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/EatAction.php b/src/EatAction.php index a1abff170..376f990ff 100644 --- a/src/EatAction.php +++ b/src/EatAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/EatAction * */ -class EatAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract +class EatAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/ElectronicsStore.php b/src/ElectronicsStore.php index 5dfbb2271..fdfdbc18a 100644 --- a/src/ElectronicsStore.php +++ b/src/ElectronicsStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/ElectronicsStore * */ -class ElectronicsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class ElectronicsStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/EmailMessage.php b/src/EmailMessage.php index 822de39c6..150d4a255 100644 --- a/src/EmailMessage.php +++ b/src/EmailMessage.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MessageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\MessageContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/EmailMessage * */ -class EmailMessage extends BaseType implements MessageContract, CreativeWorkContract, ThingContract +class EmailMessage extends BaseType implements CreativeWorkContract, MessageContract, ThingContract { /** * The subject matter of the content. diff --git a/src/Embassy.php b/src/Embassy.php index 3f1da3fbf..d76ee32f1 100644 --- a/src/Embassy.php +++ b/src/Embassy.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -13,7 +13,7 @@ * @see http://schema.org/Embassy * */ -class Embassy extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract +class Embassy extends BaseType implements CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/EmployeeRole.php b/src/EmployeeRole.php index 3382cf8fb..4d0b5a21b 100644 --- a/src/EmployeeRole.php +++ b/src/EmployeeRole.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\OrganizationRoleContract; use \Spatie\SchemaOrg\Contracts\RoleContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/EmployeeRole * */ -class EmployeeRole extends BaseType implements OrganizationRoleContract, RoleContract, IntangibleContract, ThingContract +class EmployeeRole extends BaseType implements IntangibleContract, OrganizationRoleContract, RoleContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/EmployerAggregateRating.php b/src/EmployerAggregateRating.php index cf9165780..13139531d 100644 --- a/src/EmployerAggregateRating.php +++ b/src/EmployerAggregateRating.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\AggregateRatingContract; -use \Spatie\SchemaOrg\Contracts\RatingContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\RatingContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/EmployerAggregateRating * */ -class EmployerAggregateRating extends BaseType implements AggregateRatingContract, RatingContract, IntangibleContract, ThingContract +class EmployerAggregateRating extends BaseType implements AggregateRatingContract, IntangibleContract, RatingContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/EndorseAction.php b/src/EndorseAction.php index 268eb2cd3..ff3675254 100644 --- a/src/EndorseAction.php +++ b/src/EndorseAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReactActionContract; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/EndorseAction * */ -class EndorseAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract +class EndorseAction extends BaseType implements ActionContract, AssessActionContract, ReactActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/EndorsementRating.php b/src/EndorsementRating.php index d17e9b6bc..fc50d2f34 100644 --- a/src/EndorsementRating.php +++ b/src/EndorsementRating.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\RatingContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\RatingContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -24,7 +24,7 @@ * @see http://schema.org/EndorsementRating * */ -class EndorsementRating extends BaseType implements RatingContract, IntangibleContract, ThingContract +class EndorsementRating extends BaseType implements IntangibleContract, RatingContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Energy.php b/src/Energy.php index a3d1d764e..2ed870113 100644 --- a/src/Energy.php +++ b/src/Energy.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\QuantityContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\QuantityContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/Energy * */ -class Energy extends BaseType implements QuantityContract, IntangibleContract, ThingContract +class Energy extends BaseType implements IntangibleContract, QuantityContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/EngineSpecification.php b/src/EngineSpecification.php index 2118c9b3d..d6c033774 100644 --- a/src/EngineSpecification.php +++ b/src/EngineSpecification.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/EngineSpecification * */ -class EngineSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class EngineSpecification extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/EventReservation.php b/src/EventReservation.php index ea0fa63c3..d92231881 100644 --- a/src/EventReservation.php +++ b/src/EventReservation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/EventReservation * */ -class EventReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class EventReservation extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/ExerciseAction.php b/src/ExerciseAction.php index 127311a08..a2895011f 100644 --- a/src/ExerciseAction.php +++ b/src/ExerciseAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlayActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\PlayActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ExerciseAction * */ -class ExerciseAction extends BaseType implements PlayActionContract, ActionContract, ThingContract +class ExerciseAction extends BaseType implements ActionContract, PlayActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/ExerciseGym.php b/src/ExerciseGym.php index 616534417..9842bdf9e 100644 --- a/src/ExerciseGym.php +++ b/src/ExerciseGym.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/ExerciseGym * */ -class ExerciseGym extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class ExerciseGym extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/FAQPage.php b/src/FAQPage.php index ec82861f4..bf66ac9c7 100644 --- a/src/FAQPage.php +++ b/src/FAQPage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * A [[FAQPage]] is a [[WebPage]] presenting one or more "[Frequently asked @@ -13,7 +13,7 @@ * @see http://schema.org/FAQPage * */ -class FAQPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class FAQPage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/FMRadioChannel.php b/src/FMRadioChannel.php index 42b90316c..ddc763158 100644 --- a/src/FMRadioChannel.php +++ b/src/FMRadioChannel.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\RadioChannelContract; use \Spatie\SchemaOrg\Contracts\BroadcastChannelContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\RadioChannelContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/FMRadioChannel * */ -class FMRadioChannel extends BaseType implements RadioChannelContract, BroadcastChannelContract, IntangibleContract, ThingContract +class FMRadioChannel extends BaseType implements BroadcastChannelContract, IntangibleContract, RadioChannelContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/FilmAction.php b/src/FilmAction.php index 7dd6dbc6b..600ac33ff 100644 --- a/src/FilmAction.php +++ b/src/FilmAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/FilmAction * */ -class FilmAction extends BaseType implements CreateActionContract, ActionContract, ThingContract +class FilmAction extends BaseType implements ActionContract, CreateActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/FinancialProduct.php b/src/FinancialProduct.php index a8780be59..4324a1ea2 100644 --- a/src/FinancialProduct.php +++ b/src/FinancialProduct.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/FinancialProduct * */ -class FinancialProduct extends BaseType implements ServiceContract, IntangibleContract, ThingContract +class FinancialProduct extends BaseType implements IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/FireStation.php b/src/FireStation.php index 3c94088a1..96407fb13 100644 --- a/src/FireStation.php +++ b/src/FireStation.php @@ -4,10 +4,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; -use \Spatie\SchemaOrg\Contracts\PlaceContract; -use \Spatie\SchemaOrg\Contracts\ThingContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; /** * A fire station. With firemen. @@ -15,7 +15,7 @@ * @see http://schema.org/FireStation * */ -class FireStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract +class FireStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/Flight.php b/src/Flight.php index 096b1aee8..13e8215c6 100644 --- a/src/Flight.php +++ b/src/Flight.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TripContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TripContract; /** * An airline flight. @@ -12,7 +12,7 @@ * @see http://schema.org/Flight * */ -class Flight extends BaseType implements TripContract, IntangibleContract, ThingContract +class Flight extends BaseType implements IntangibleContract, ThingContract, TripContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/FlightReservation.php b/src/FlightReservation.php index a579b15dd..a00d6a912 100644 --- a/src/FlightReservation.php +++ b/src/FlightReservation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/FlightReservation * */ -class FlightReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class FlightReservation extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Florist.php b/src/Florist.php index 881f33b69..4d07f1f47 100644 --- a/src/Florist.php +++ b/src/Florist.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/Florist * */ -class Florist extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class Florist extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/FollowAction.php b/src/FollowAction.php index 6eb2e4d5b..bb89db0ec 100644 --- a/src/FollowAction.php +++ b/src/FollowAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -27,7 +27,7 @@ * @see http://schema.org/FollowAction * */ -class FollowAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class FollowAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/FoodEstablishmentReservation.php b/src/FoodEstablishmentReservation.php index 70c164673..4e3f137a6 100644 --- a/src/FoodEstablishmentReservation.php +++ b/src/FoodEstablishmentReservation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/FoodEstablishmentReservation * */ -class FoodEstablishmentReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class FoodEstablishmentReservation extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/FoodService.php b/src/FoodService.php index 21c709d1e..015820839 100644 --- a/src/FoodService.php +++ b/src/FoodService.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/FoodService * */ -class FoodService extends BaseType implements ServiceContract, IntangibleContract, ThingContract +class FoodService extends BaseType implements IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/FurnitureStore.php b/src/FurnitureStore.php index 6bda683c3..d91c9b255 100644 --- a/src/FurnitureStore.php +++ b/src/FurnitureStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/FurnitureStore * */ -class FurnitureStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class FurnitureStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/GardenStore.php b/src/GardenStore.php index 2816b2959..a2f2aa80f 100644 --- a/src/GardenStore.php +++ b/src/GardenStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/GardenStore * */ -class GardenStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class GardenStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/GatedResidenceCommunity.php b/src/GatedResidenceCommunity.php index c3b7b062b..20e8ba834 100644 --- a/src/GatedResidenceCommunity.php +++ b/src/GatedResidenceCommunity.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ResidenceContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ResidenceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/GatedResidenceCommunity * */ -class GatedResidenceCommunity extends BaseType implements ResidenceContract, PlaceContract, ThingContract +class GatedResidenceCommunity extends BaseType implements PlaceContract, ResidenceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/GeoCircle.php b/src/GeoCircle.php index 6c18ee5c1..0af8bce68 100644 --- a/src/GeoCircle.php +++ b/src/GeoCircle.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\GeoShapeContract; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -18,7 +18,7 @@ * @see http://schema.org/GeoCircle * */ -class GeoCircle extends BaseType implements GeoShapeContract, StructuredValueContract, IntangibleContract, ThingContract +class GeoCircle extends BaseType implements GeoShapeContract, IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/GeoCoordinates.php b/src/GeoCoordinates.php index cd668e1ee..3281eb978 100644 --- a/src/GeoCoordinates.php +++ b/src/GeoCoordinates.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/GeoCoordinates * */ -class GeoCoordinates extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class GeoCoordinates extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/GeoShape.php b/src/GeoShape.php index b77ab7cf7..c8b66a447 100644 --- a/src/GeoShape.php +++ b/src/GeoShape.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/GeoShape * */ -class GeoShape extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class GeoShape extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/GiveAction.php b/src/GiveAction.php index b00deec7e..130fa8ca5 100644 --- a/src/GiveAction.php +++ b/src/GiveAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TransferActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; /** * The act of transferring ownership of an object to a destination. Reciprocal @@ -20,7 +20,7 @@ * @see http://schema.org/GiveAction * */ -class GiveAction extends BaseType implements TransferActionContract, ActionContract, ThingContract +class GiveAction extends BaseType implements ActionContract, ThingContract, TransferActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/GolfCourse.php b/src/GolfCourse.php index 2d60604ec..175a8f003 100644 --- a/src/GolfCourse.php +++ b/src/GolfCourse.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/GolfCourse * */ -class GolfCourse extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class GolfCourse extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/GovernmentPermit.php b/src/GovernmentPermit.php index f7f439100..ada3b769a 100644 --- a/src/GovernmentPermit.php +++ b/src/GovernmentPermit.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PermitContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\PermitContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/GovernmentPermit * */ -class GovernmentPermit extends BaseType implements PermitContract, IntangibleContract, ThingContract +class GovernmentPermit extends BaseType implements IntangibleContract, PermitContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/GovernmentService.php b/src/GovernmentService.php index 54217b75d..517190243 100644 --- a/src/GovernmentService.php +++ b/src/GovernmentService.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/GovernmentService * */ -class GovernmentService extends BaseType implements ServiceContract, IntangibleContract, ThingContract +class GovernmentService extends BaseType implements IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/GroceryStore.php b/src/GroceryStore.php index 207e8d157..0b131c6eb 100644 --- a/src/GroceryStore.php +++ b/src/GroceryStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/GroceryStore * */ -class GroceryStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class GroceryStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/HardwareStore.php b/src/HardwareStore.php index 4aebd0405..284edb47a 100644 --- a/src/HardwareStore.php +++ b/src/HardwareStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/HardwareStore * */ -class HardwareStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class HardwareStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/HealthClub.php b/src/HealthClub.php index f7678ee3e..1e92cafda 100644 --- a/src/HealthClub.php +++ b/src/HealthClub.php @@ -3,10 +3,10 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\HealthAndBeautyBusinessContract; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/HealthClub * */ -class HealthClub extends BaseType implements HealthAndBeautyBusinessContract, SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class HealthClub extends BaseType implements HealthAndBeautyBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/HinduTemple.php b/src/HinduTemple.php index 54e5b954c..c04d60692 100644 --- a/src/HinduTemple.php +++ b/src/HinduTemple.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/HinduTemple * */ -class HinduTemple extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract +class HinduTemple extends BaseType implements CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/HobbyShop.php b/src/HobbyShop.php index 92b046d96..f3e5825f7 100644 --- a/src/HobbyShop.php +++ b/src/HobbyShop.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/HobbyShop * */ -class HobbyShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class HobbyShop extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/HomeGoodsStore.php b/src/HomeGoodsStore.php index e564f8b44..977033cd9 100644 --- a/src/HomeGoodsStore.php +++ b/src/HomeGoodsStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/HomeGoodsStore * */ -class HomeGoodsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class HomeGoodsStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/Hospital.php b/src/Hospital.php index 1579e7666..9869ee6b6 100644 --- a/src/Hospital.php +++ b/src/Hospital.php @@ -4,11 +4,11 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; +use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\MedicalOrganizationContract; +use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; -use \Spatie\SchemaOrg\Contracts\OrganizationContract; /** * A hospital. @@ -16,7 +16,7 @@ * @see http://schema.org/Hospital * */ -class Hospital extends BaseType implements CivicStructureContract, EmergencyServiceContract, MedicalOrganizationContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract +class Hospital extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, MedicalOrganizationContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/Hostel.php b/src/Hostel.php index 49e5ed058..6c82c6862 100644 --- a/src/Hostel.php +++ b/src/Hostel.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -17,7 +17,7 @@ * @see http://schema.org/Hostel * */ -class Hostel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class Hostel extends BaseType implements LocalBusinessContract, LodgingBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/Hotel.php b/src/Hotel.php index 7b129ca95..a69f23cf0 100644 --- a/src/Hotel.php +++ b/src/Hotel.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -19,7 +19,7 @@ * @see http://schema.org/Hotel * */ -class Hotel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class Hotel extends BaseType implements LocalBusinessContract, LodgingBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/HotelRoom.php b/src/HotelRoom.php index 4184c1214..67ffe46b2 100644 --- a/src/HotelRoom.php +++ b/src/HotelRoom.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\RoomContract; use \Spatie\SchemaOrg\Contracts\AccommodationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\RoomContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/HotelRoom * */ -class HotelRoom extends BaseType implements RoomContract, AccommodationContract, PlaceContract, ThingContract +class HotelRoom extends BaseType implements AccommodationContract, PlaceContract, RoomContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/HowToDirection.php b/src/HowToDirection.php index 47d4434ab..04cef4fb1 100644 --- a/src/HowToDirection.php +++ b/src/HowToDirection.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/HowToDirection * */ -class HowToDirection extends BaseType implements ListItemContract, CreativeWorkContract, IntangibleContract, ThingContract +class HowToDirection extends BaseType implements CreativeWorkContract, IntangibleContract, ListItemContract, ThingContract { /** * The subject matter of the content. diff --git a/src/HowToItem.php b/src/HowToItem.php index 079f25f0a..23a59064d 100644 --- a/src/HowToItem.php +++ b/src/HowToItem.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/HowToItem * */ -class HowToItem extends BaseType implements ListItemContract, IntangibleContract, ThingContract +class HowToItem extends BaseType implements IntangibleContract, ListItemContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/HowToSection.php b/src/HowToSection.php index 071203b58..a71894c1a 100644 --- a/src/HowToSection.php +++ b/src/HowToSection.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ItemListContract; -use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ItemListContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/HowToSection * */ -class HowToSection extends BaseType implements ItemListContract, ListItemContract, CreativeWorkContract, IntangibleContract, ThingContract +class HowToSection extends BaseType implements CreativeWorkContract, IntangibleContract, ItemListContract, ListItemContract, ThingContract { /** * The subject matter of the content. diff --git a/src/HowToStep.php b/src/HowToStep.php index 4f172a7c9..bed070837 100644 --- a/src/HowToStep.php +++ b/src/HowToStep.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ListItemContract; -use \Spatie\SchemaOrg\Contracts\ItemListContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ItemListContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/HowToStep * */ -class HowToStep extends BaseType implements ListItemContract, ItemListContract, CreativeWorkContract, IntangibleContract, ThingContract +class HowToStep extends BaseType implements CreativeWorkContract, IntangibleContract, ItemListContract, ListItemContract, ThingContract { /** * The subject matter of the content. diff --git a/src/HowToSupply.php b/src/HowToSupply.php index 5c4b403ec..1db283cd1 100644 --- a/src/HowToSupply.php +++ b/src/HowToSupply.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\HowToItemContract; -use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/HowToSupply * */ -class HowToSupply extends BaseType implements HowToItemContract, ListItemContract, IntangibleContract, ThingContract +class HowToSupply extends BaseType implements HowToItemContract, IntangibleContract, ListItemContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/HowToTip.php b/src/HowToTip.php index e85b08ed8..8e22348e0 100644 --- a/src/HowToTip.php +++ b/src/HowToTip.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/HowToTip * */ -class HowToTip extends BaseType implements ListItemContract, CreativeWorkContract, IntangibleContract, ThingContract +class HowToTip extends BaseType implements CreativeWorkContract, IntangibleContract, ListItemContract, ThingContract { /** * The subject matter of the content. diff --git a/src/HowToTool.php b/src/HowToTool.php index 3c5654b4d..234d7c068 100644 --- a/src/HowToTool.php +++ b/src/HowToTool.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\HowToItemContract; -use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ListItemContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/HowToTool * */ -class HowToTool extends BaseType implements HowToItemContract, ListItemContract, IntangibleContract, ThingContract +class HowToTool extends BaseType implements HowToItemContract, IntangibleContract, ListItemContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/IgnoreAction.php b/src/IgnoreAction.php index ed7b93a9a..f2e68ecd7 100644 --- a/src/IgnoreAction.php +++ b/src/IgnoreAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/IgnoreAction * */ -class IgnoreAction extends BaseType implements AssessActionContract, ActionContract, ThingContract +class IgnoreAction extends BaseType implements ActionContract, AssessActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/ImageGallery.php b/src/ImageGallery.php index 93d92e03c..d2b092e9c 100644 --- a/src/ImageGallery.php +++ b/src/ImageGallery.php @@ -3,9 +3,9 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\CollectionPageContract; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * Web page type: Image gallery page. @@ -13,7 +13,7 @@ * @see http://schema.org/ImageGallery * */ -class ImageGallery extends BaseType implements CollectionPageContract, WebPageContract, CreativeWorkContract, ThingContract +class ImageGallery extends BaseType implements CollectionPageContract, CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/ImageObject.php b/src/ImageObject.php index fd82bb331..3530f92fd 100644 --- a/src/ImageObject.php +++ b/src/ImageObject.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/ImageObject * */ -class ImageObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract +class ImageObject extends BaseType implements CreativeWorkContract, MediaObjectContract, ThingContract { /** * The subject matter of the content. diff --git a/src/InformAction.php b/src/InformAction.php index 374439f68..8cd84545d 100644 --- a/src/InformAction.php +++ b/src/InformAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/InformAction * */ -class InformAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class InformAction extends BaseType implements ActionContract, CommunicateActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/InsertAction.php b/src/InsertAction.php index 375ef51f1..0159f0cd8 100644 --- a/src/InsertAction.php +++ b/src/InsertAction.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\AddActionContract; -use \Spatie\SchemaOrg\Contracts\UpdateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AddActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; /** * The act of adding at a specific location in an ordered collection. @@ -13,7 +13,7 @@ * @see http://schema.org/InsertAction * */ -class InsertAction extends BaseType implements AddActionContract, UpdateActionContract, ActionContract, ThingContract +class InsertAction extends BaseType implements ActionContract, AddActionContract, ThingContract, UpdateActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/InstallAction.php b/src/InstallAction.php index d3da9e2d3..c80cc52aa 100644 --- a/src/InstallAction.php +++ b/src/InstallAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/InstallAction * */ -class InstallAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract +class InstallAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/InteractionCounter.php b/src/InteractionCounter.php index 1c5481924..54a24c776 100644 --- a/src/InteractionCounter.php +++ b/src/InteractionCounter.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/InteractionCounter * */ -class InteractionCounter extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class InteractionCounter extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/InvestmentOrDeposit.php b/src/InvestmentOrDeposit.php index 22d87875b..eaa668203 100644 --- a/src/InvestmentOrDeposit.php +++ b/src/InvestmentOrDeposit.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/InvestmentOrDeposit * */ -class InvestmentOrDeposit extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract +class InvestmentOrDeposit extends BaseType implements FinancialProductContract, IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/InviteAction.php b/src/InviteAction.php index 2022fffa6..59ffd800f 100644 --- a/src/InviteAction.php +++ b/src/InviteAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/InviteAction * */ -class InviteAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class InviteAction extends BaseType implements ActionContract, CommunicateActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/ItemPage.php b/src/ItemPage.php index e6c236c1e..75cf97f79 100644 --- a/src/ItemPage.php +++ b/src/ItemPage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * A page devoted to a single item, such as a particular product or hotel. @@ -12,7 +12,7 @@ * @see http://schema.org/ItemPage * */ -class ItemPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class ItemPage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/JewelryStore.php b/src/JewelryStore.php index dcef47054..ed1ff29e5 100644 --- a/src/JewelryStore.php +++ b/src/JewelryStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/JewelryStore * */ -class JewelryStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class JewelryStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/JoinAction.php b/src/JoinAction.php index 125d8e64c..ab077c9a1 100644 --- a/src/JoinAction.php +++ b/src/JoinAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -21,7 +21,7 @@ * @see http://schema.org/JoinAction * */ -class JoinAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class JoinAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/LeaveAction.php b/src/LeaveAction.php index f225e9258..a240e6211 100644 --- a/src/LeaveAction.php +++ b/src/LeaveAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -18,7 +18,7 @@ * @see http://schema.org/LeaveAction * */ -class LeaveAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class LeaveAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/LegislativeBuilding.php b/src/LegislativeBuilding.php index 83ce2fb6d..b8f6b9f4f 100644 --- a/src/LegislativeBuilding.php +++ b/src/LegislativeBuilding.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; +use \Spatie\SchemaOrg\Contracts\GovernmentBuildingContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -13,7 +13,7 @@ * @see http://schema.org/LegislativeBuilding * */ -class LegislativeBuilding extends BaseType implements GovernmentBuildingContract, CivicStructureContract, PlaceContract, ThingContract +class LegislativeBuilding extends BaseType implements CivicStructureContract, GovernmentBuildingContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/LendAction.php b/src/LendAction.php index 14b7d8717..ff106411d 100644 --- a/src/LendAction.php +++ b/src/LendAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TransferActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; /** * The act of providing an object under an agreement that it will be returned at @@ -17,7 +17,7 @@ * @see http://schema.org/LendAction * */ -class LendAction extends BaseType implements TransferActionContract, ActionContract, ThingContract +class LendAction extends BaseType implements ActionContract, ThingContract, TransferActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/LikeAction.php b/src/LikeAction.php index 4a5ecae12..c1754c64c 100644 --- a/src/LikeAction.php +++ b/src/LikeAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReactActionContract; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/LikeAction * */ -class LikeAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract +class LikeAction extends BaseType implements ActionContract, AssessActionContract, ReactActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/LiquorStore.php b/src/LiquorStore.php index f554a510c..ef6210b7d 100644 --- a/src/LiquorStore.php +++ b/src/LiquorStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/LiquorStore * */ -class LiquorStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class LiquorStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/ListenAction.php b/src/ListenAction.php index 135ef839a..dd110fbb2 100644 --- a/src/ListenAction.php +++ b/src/ListenAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/ListenAction * */ -class ListenAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract +class ListenAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/LiveBlogPosting.php b/src/LiveBlogPosting.php index c70f236c4..ed450ac23 100644 --- a/src/LiveBlogPosting.php +++ b/src/LiveBlogPosting.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\BlogPostingContract; -use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; use \Spatie\SchemaOrg\Contracts\ArticleContract; +use \Spatie\SchemaOrg\Contracts\BlogPostingContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SocialMediaPostingContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/LiveBlogPosting * */ -class LiveBlogPosting extends BaseType implements BlogPostingContract, SocialMediaPostingContract, ArticleContract, CreativeWorkContract, ThingContract +class LiveBlogPosting extends BaseType implements ArticleContract, BlogPostingContract, CreativeWorkContract, SocialMediaPostingContract, ThingContract { /** * The subject matter of the content. diff --git a/src/LoanOrCredit.php b/src/LoanOrCredit.php index 82f0434c4..cd02d1ee5 100644 --- a/src/LoanOrCredit.php +++ b/src/LoanOrCredit.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/LoanOrCredit * */ -class LoanOrCredit extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract +class LoanOrCredit extends BaseType implements FinancialProductContract, IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/LocationFeatureSpecification.php b/src/LocationFeatureSpecification.php index 75a1c1897..3cb76d471 100644 --- a/src/LocationFeatureSpecification.php +++ b/src/LocationFeatureSpecification.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\PropertyValueContract; use \Spatie\SchemaOrg\Contracts\StructuredValueContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/LocationFeatureSpecification * */ -class LocationFeatureSpecification extends BaseType implements PropertyValueContract, StructuredValueContract, IntangibleContract, ThingContract +class LocationFeatureSpecification extends BaseType implements IntangibleContract, PropertyValueContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/LodgingReservation.php b/src/LodgingReservation.php index 8efe7dcea..57c33f539 100644 --- a/src/LodgingReservation.php +++ b/src/LodgingReservation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/LodgingReservation * */ -class LodgingReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class LodgingReservation extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/MarryAction.php b/src/MarryAction.php index c68671e4d..e252c464f 100644 --- a/src/MarryAction.php +++ b/src/MarryAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/MarryAction * */ -class MarryAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class MarryAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/Mass.php b/src/Mass.php index f2aadde96..83b3fdc98 100644 --- a/src/Mass.php +++ b/src/Mass.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\QuantityContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\QuantityContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/Mass * */ -class Mass extends BaseType implements QuantityContract, IntangibleContract, ThingContract +class Mass extends BaseType implements IntangibleContract, QuantityContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/MeetingRoom.php b/src/MeetingRoom.php index 56712b23e..897d98dfe 100644 --- a/src/MeetingRoom.php +++ b/src/MeetingRoom.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\RoomContract; use \Spatie\SchemaOrg\Contracts\AccommodationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\RoomContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -19,7 +19,7 @@ * @see http://schema.org/MeetingRoom * */ -class MeetingRoom extends BaseType implements RoomContract, AccommodationContract, PlaceContract, ThingContract +class MeetingRoom extends BaseType implements AccommodationContract, PlaceContract, RoomContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/MensClothingStore.php b/src/MensClothingStore.php index ae0206bd4..ee51c1c3f 100644 --- a/src/MensClothingStore.php +++ b/src/MensClothingStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/MensClothingStore * */ -class MensClothingStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class MensClothingStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/MobileApplication.php b/src/MobileApplication.php index d7f628d32..66fc07804 100644 --- a/src/MobileApplication.php +++ b/src/MobileApplication.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/MobileApplication * */ -class MobileApplication extends BaseType implements SoftwareApplicationContract, CreativeWorkContract, ThingContract +class MobileApplication extends BaseType implements CreativeWorkContract, SoftwareApplicationContract, ThingContract { /** * The subject matter of the content. diff --git a/src/MobilePhoneStore.php b/src/MobilePhoneStore.php index 59b1b81f0..589b930ad 100644 --- a/src/MobilePhoneStore.php +++ b/src/MobilePhoneStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/MobilePhoneStore * */ -class MobilePhoneStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class MobilePhoneStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/MonetaryAmount.php b/src/MonetaryAmount.php index 5763b7815..1c6a8c831 100644 --- a/src/MonetaryAmount.php +++ b/src/MonetaryAmount.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/MonetaryAmount * */ -class MonetaryAmount extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class MonetaryAmount extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/MonetaryAmountDistribution.php b/src/MonetaryAmountDistribution.php index 5ec4fa98e..d38cc0678 100644 --- a/src/MonetaryAmountDistribution.php +++ b/src/MonetaryAmountDistribution.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\QuantitativeValueDistributionContract; use \Spatie\SchemaOrg\Contracts\StructuredValueContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/MonetaryAmountDistribution * */ -class MonetaryAmountDistribution extends BaseType implements QuantitativeValueDistributionContract, StructuredValueContract, IntangibleContract, ThingContract +class MonetaryAmountDistribution extends BaseType implements IntangibleContract, QuantitativeValueDistributionContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Mosque.php b/src/Mosque.php index 3b2a340b8..cd7c3c1b5 100644 --- a/src/Mosque.php +++ b/src/Mosque.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/Mosque * */ -class Mosque extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract +class Mosque extends BaseType implements CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/Motel.php b/src/Motel.php index 0e646d937..9743bfa51 100644 --- a/src/Motel.php +++ b/src/Motel.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -17,7 +17,7 @@ * @see http://schema.org/Motel * */ -class Motel extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class Motel extends BaseType implements LocalBusinessContract, LodgingBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/MovieRentalStore.php b/src/MovieRentalStore.php index b44940221..41d4d1664 100644 --- a/src/MovieRentalStore.php +++ b/src/MovieRentalStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/MovieRentalStore * */ -class MovieRentalStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class MovieRentalStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/MovieSeries.php b/src/MovieSeries.php index 8dd6c8113..0018b04d5 100644 --- a/src/MovieSeries.php +++ b/src/MovieSeries.php @@ -2,11 +2,11 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A series of movies. Included movies can be indicated with the hasPart @@ -15,7 +15,7 @@ * @see http://schema.org/MovieSeries * */ -class MovieSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract +class MovieSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, IntangibleContract, SeriesContract, ThingContract { /** * The subject matter of the content. diff --git a/src/MovieTheater.php b/src/MovieTheater.php index 90fdfd8fd..1428ce3d4 100644 --- a/src/MovieTheater.php +++ b/src/MovieTheater.php @@ -4,10 +4,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\EntertainmentBusinessContract; -use \Spatie\SchemaOrg\Contracts\PlaceContract; -use \Spatie\SchemaOrg\Contracts\ThingContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; /** * A movie theater. @@ -15,7 +15,7 @@ * @see http://schema.org/MovieTheater * */ -class MovieTheater extends BaseType implements CivicStructureContract, EntertainmentBusinessContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract +class MovieTheater extends BaseType implements CivicStructureContract, EntertainmentBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/MusicAlbum.php b/src/MusicAlbum.php index 239716fc7..c7e55c3a1 100644 --- a/src/MusicAlbum.php +++ b/src/MusicAlbum.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MusicPlaylistContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\MusicPlaylistContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/MusicAlbum * */ -class MusicAlbum extends BaseType implements MusicPlaylistContract, CreativeWorkContract, ThingContract +class MusicAlbum extends BaseType implements CreativeWorkContract, MusicPlaylistContract, ThingContract { /** * The subject matter of the content. diff --git a/src/MusicGroup.php b/src/MusicGroup.php index efa074d59..18887792d 100644 --- a/src/MusicGroup.php +++ b/src/MusicGroup.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/MusicGroup * */ -class MusicGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract +class MusicGroup extends BaseType implements OrganizationContract, PerformingGroupContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/MusicRelease.php b/src/MusicRelease.php index bf3cbaa9c..99419b0ba 100644 --- a/src/MusicRelease.php +++ b/src/MusicRelease.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MusicPlaylistContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\MusicPlaylistContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/MusicRelease * */ -class MusicRelease extends BaseType implements MusicPlaylistContract, CreativeWorkContract, ThingContract +class MusicRelease extends BaseType implements CreativeWorkContract, MusicPlaylistContract, ThingContract { /** * The subject matter of the content. diff --git a/src/MusicStore.php b/src/MusicStore.php index cbb9bde78..16109fb73 100644 --- a/src/MusicStore.php +++ b/src/MusicStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/MusicStore * */ -class MusicStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class MusicStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/MusicVideoObject.php b/src/MusicVideoObject.php index 048015878..ac708ad03 100644 --- a/src/MusicVideoObject.php +++ b/src/MusicVideoObject.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/MusicVideoObject * */ -class MusicVideoObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract +class MusicVideoObject extends BaseType implements CreativeWorkContract, MediaObjectContract, ThingContract { /** * The subject matter of the content. diff --git a/src/NoteDigitalDocument.php b/src/NoteDigitalDocument.php index 5730ee066..8060fa8c9 100644 --- a/src/NoteDigitalDocument.php +++ b/src/NoteDigitalDocument.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/NoteDigitalDocument * */ -class NoteDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract +class NoteDigitalDocument extends BaseType implements CreativeWorkContract, DigitalDocumentContract, ThingContract { /** * The subject matter of the content. diff --git a/src/NutritionInformation.php b/src/NutritionInformation.php index dc5970520..a9f7263ba 100644 --- a/src/NutritionInformation.php +++ b/src/NutritionInformation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/NutritionInformation * */ -class NutritionInformation extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class NutritionInformation extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/OfferCatalog.php b/src/OfferCatalog.php index 2e0f68f14..3ab86b82f 100644 --- a/src/OfferCatalog.php +++ b/src/OfferCatalog.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ItemListContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ItemListContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/OfferCatalog * */ -class OfferCatalog extends BaseType implements ItemListContract, IntangibleContract, ThingContract +class OfferCatalog extends BaseType implements IntangibleContract, ItemListContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/OfficeEquipmentStore.php b/src/OfficeEquipmentStore.php index 1380d72ce..077c64efd 100644 --- a/src/OfficeEquipmentStore.php +++ b/src/OfficeEquipmentStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/OfficeEquipmentStore * */ -class OfficeEquipmentStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class OfficeEquipmentStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/OnDemandEvent.php b/src/OnDemandEvent.php index 6d6020a3a..2514b1114 100644 --- a/src/OnDemandEvent.php +++ b/src/OnDemandEvent.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PublicationEventContract; use \Spatie\SchemaOrg\Contracts\EventContract; +use \Spatie\SchemaOrg\Contracts\PublicationEventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/OnDemandEvent * */ -class OnDemandEvent extends BaseType implements PublicationEventContract, EventContract, ThingContract +class OnDemandEvent extends BaseType implements EventContract, PublicationEventContract, ThingContract { /** * The subject matter of the content. diff --git a/src/OpeningHoursSpecification.php b/src/OpeningHoursSpecification.php index ee70b5627..37f063627 100644 --- a/src/OpeningHoursSpecification.php +++ b/src/OpeningHoursSpecification.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -20,7 +20,7 @@ * @see http://schema.org/OpeningHoursSpecification * */ -class OpeningHoursSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class OpeningHoursSpecification extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/OrderAction.php b/src/OrderAction.php index 0a227996a..fc4b2df15 100644 --- a/src/OrderAction.php +++ b/src/OrderAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * An agent orders an object/product/service to be delivered/sent. @@ -12,7 +12,7 @@ * @see http://schema.org/OrderAction * */ -class OrderAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class OrderAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/OrganizationRole.php b/src/OrganizationRole.php index 27d9c1cf9..92955a14d 100644 --- a/src/OrganizationRole.php +++ b/src/OrganizationRole.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\RoleContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\RoleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/OrganizationRole * */ -class OrganizationRole extends BaseType implements RoleContract, IntangibleContract, ThingContract +class OrganizationRole extends BaseType implements IntangibleContract, RoleContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/OutletStore.php b/src/OutletStore.php index 00afd6ffc..de94ce2db 100644 --- a/src/OutletStore.php +++ b/src/OutletStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/OutletStore * */ -class OutletStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class OutletStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/OwnershipInfo.php b/src/OwnershipInfo.php index e7b774d09..ef4c28d33 100644 --- a/src/OwnershipInfo.php +++ b/src/OwnershipInfo.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/OwnershipInfo * */ -class OwnershipInfo extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class OwnershipInfo extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * The organization or person from which the product was acquired. diff --git a/src/PaintAction.php b/src/PaintAction.php index 860ae93f4..fd0d1d9b5 100644 --- a/src/PaintAction.php +++ b/src/PaintAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/PaintAction * */ -class PaintAction extends BaseType implements CreateActionContract, ActionContract, ThingContract +class PaintAction extends BaseType implements ActionContract, CreateActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/ParentAudience.php b/src/ParentAudience.php index 6f10da5fa..3c0705c33 100644 --- a/src/ParentAudience.php +++ b/src/ParentAudience.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PeopleAudienceContract; use \Spatie\SchemaOrg\Contracts\AudienceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\PeopleAudienceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/ParentAudience * */ -class ParentAudience extends BaseType implements PeopleAudienceContract, AudienceContract, IntangibleContract, ThingContract +class ParentAudience extends BaseType implements AudienceContract, IntangibleContract, PeopleAudienceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/PawnShop.php b/src/PawnShop.php index c93ee6a70..9460f9e17 100644 --- a/src/PawnShop.php +++ b/src/PawnShop.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/PawnShop * */ -class PawnShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class PawnShop extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/PayAction.php b/src/PayAction.php index 503e05141..575cd2e61 100644 --- a/src/PayAction.php +++ b/src/PayAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * An agent pays a price to a participant. @@ -12,7 +12,7 @@ * @see http://schema.org/PayAction * */ -class PayAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class PayAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/PaymentCard.php b/src/PaymentCard.php index 050588fd2..5ebaa8cc2 100644 --- a/src/PaymentCard.php +++ b/src/PaymentCard.php @@ -2,12 +2,12 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\EnumerationContract; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\PaymentMethodContract; use \Spatie\SchemaOrg\Contracts\ServiceContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\EnumerationContract; /** * A payment method using a credit, debit, store or other card to associate the @@ -16,7 +16,7 @@ * @see http://schema.org/PaymentCard * */ -class PaymentCard extends BaseType implements FinancialProductContract, PaymentMethodContract, ServiceContract, IntangibleContract, ThingContract, EnumerationContract +class PaymentCard extends BaseType implements EnumerationContract, FinancialProductContract, IntangibleContract, PaymentMethodContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/PaymentChargeSpecification.php b/src/PaymentChargeSpecification.php index 065a7f769..96a815e71 100644 --- a/src/PaymentChargeSpecification.php +++ b/src/PaymentChargeSpecification.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\PriceSpecificationContract; use \Spatie\SchemaOrg\Contracts\StructuredValueContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/PaymentChargeSpecification * */ -class PaymentChargeSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract +class PaymentChargeSpecification extends BaseType implements IntangibleContract, PriceSpecificationContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/PaymentService.php b/src/PaymentService.php index 130d54bf7..41d709f14 100644 --- a/src/PaymentService.php +++ b/src/PaymentService.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\FinancialProductContract; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/PaymentService * */ -class PaymentService extends BaseType implements FinancialProductContract, ServiceContract, IntangibleContract, ThingContract +class PaymentService extends BaseType implements FinancialProductContract, IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/PerformAction.php b/src/PerformAction.php index 31d5e12c8..7aae288e5 100644 --- a/src/PerformAction.php +++ b/src/PerformAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlayActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\PlayActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/PerformAction * */ -class PerformAction extends BaseType implements PlayActionContract, ActionContract, ThingContract +class PerformAction extends BaseType implements ActionContract, PlayActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/PerformanceRole.php b/src/PerformanceRole.php index 675b4e983..b3d74a47a 100644 --- a/src/PerformanceRole.php +++ b/src/PerformanceRole.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\RoleContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\RoleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/PerformanceRole * */ -class PerformanceRole extends BaseType implements RoleContract, IntangibleContract, ThingContract +class PerformanceRole extends BaseType implements IntangibleContract, RoleContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/Periodical.php b/src/Periodical.php index 509aade31..416af2d41 100644 --- a/src/Periodical.php +++ b/src/Periodical.php @@ -2,11 +2,11 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A publication in any medium issued in successive parts bearing numerical or @@ -19,7 +19,7 @@ * @see http://schema.org/Periodical * */ -class Periodical extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract +class Periodical extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, IntangibleContract, SeriesContract, ThingContract { /** * The subject matter of the content. diff --git a/src/PetStore.php b/src/PetStore.php index b1077137d..7b1eaf4bd 100644 --- a/src/PetStore.php +++ b/src/PetStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/PetStore * */ -class PetStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class PetStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/PhotographAction.php b/src/PhotographAction.php index 16d12aa2e..1db3fcf92 100644 --- a/src/PhotographAction.php +++ b/src/PhotographAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/PhotographAction * */ -class PhotographAction extends BaseType implements CreateActionContract, ActionContract, ThingContract +class PhotographAction extends BaseType implements ActionContract, CreateActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/PlanAction.php b/src/PlanAction.php index 4101932b6..440a535ad 100644 --- a/src/PlanAction.php +++ b/src/PlanAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/PlanAction * */ -class PlanAction extends BaseType implements OrganizeActionContract, ActionContract, ThingContract +class PlanAction extends BaseType implements ActionContract, OrganizeActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/PoliceStation.php b/src/PoliceStation.php index 67eb809db..6065b85e7 100644 --- a/src/PoliceStation.php +++ b/src/PoliceStation.php @@ -4,10 +4,10 @@ use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\EmergencyServiceContract; -use \Spatie\SchemaOrg\Contracts\PlaceContract; -use \Spatie\SchemaOrg\Contracts\ThingContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; /** * A police station. @@ -15,7 +15,7 @@ * @see http://schema.org/PoliceStation * */ -class PoliceStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract +class PoliceStation extends BaseType implements CivicStructureContract, EmergencyServiceContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/PostalAddress.php b/src/PostalAddress.php index 383459f05..984fdccd3 100644 --- a/src/PostalAddress.php +++ b/src/PostalAddress.php @@ -3,8 +3,8 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\ContactPointContract; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/PostalAddress * */ -class PostalAddress extends BaseType implements ContactPointContract, StructuredValueContract, IntangibleContract, ThingContract +class PostalAddress extends BaseType implements ContactPointContract, IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/PreOrderAction.php b/src/PreOrderAction.php index 70b2544f3..1295aebad 100644 --- a/src/PreOrderAction.php +++ b/src/PreOrderAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * An agent orders a (not yet released) object/product/service to be @@ -13,7 +13,7 @@ * @see http://schema.org/PreOrderAction * */ -class PreOrderAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class PreOrderAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/PrependAction.php b/src/PrependAction.php index 797f4dfd6..24b091102 100644 --- a/src/PrependAction.php +++ b/src/PrependAction.php @@ -2,11 +2,11 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InsertActionContract; -use \Spatie\SchemaOrg\Contracts\AddActionContract; -use \Spatie\SchemaOrg\Contracts\UpdateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AddActionContract; +use \Spatie\SchemaOrg\Contracts\InsertActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; /** * The act of inserting at the beginning if an ordered collection. @@ -14,7 +14,7 @@ * @see http://schema.org/PrependAction * */ -class PrependAction extends BaseType implements InsertActionContract, AddActionContract, UpdateActionContract, ActionContract, ThingContract +class PrependAction extends BaseType implements ActionContract, AddActionContract, InsertActionContract, ThingContract, UpdateActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/PresentationDigitalDocument.php b/src/PresentationDigitalDocument.php index 56517c6a7..2550a3d43 100644 --- a/src/PresentationDigitalDocument.php +++ b/src/PresentationDigitalDocument.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/PresentationDigitalDocument * */ -class PresentationDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract +class PresentationDigitalDocument extends BaseType implements CreativeWorkContract, DigitalDocumentContract, ThingContract { /** * The subject matter of the content. diff --git a/src/PriceSpecification.php b/src/PriceSpecification.php index 10a39d2c9..d38bb5fff 100644 --- a/src/PriceSpecification.php +++ b/src/PriceSpecification.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/PriceSpecification * */ -class PriceSpecification extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class PriceSpecification extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/ProfilePage.php b/src/ProfilePage.php index 5b8c84789..7b7035c24 100644 --- a/src/ProfilePage.php +++ b/src/ProfilePage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * Web page type: Profile page. @@ -12,7 +12,7 @@ * @see http://schema.org/ProfilePage * */ -class ProfilePage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class ProfilePage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/PropertyValue.php b/src/PropertyValue.php index d3cb24b91..de87edd06 100644 --- a/src/PropertyValue.php +++ b/src/PropertyValue.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -19,7 +19,7 @@ * @see http://schema.org/PropertyValue * */ -class PropertyValue extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class PropertyValue extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/PublicSwimmingPool.php b/src/PublicSwimmingPool.php index 5b094cd74..6dc36a3cd 100644 --- a/src/PublicSwimmingPool.php +++ b/src/PublicSwimmingPool.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/PublicSwimmingPool * */ -class PublicSwimmingPool extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class PublicSwimmingPool extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/QAPage.php b/src/QAPage.php index 214567a8e..6cc02769f 100644 --- a/src/QAPage.php +++ b/src/QAPage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * A QAPage is a WebPage focussed on a specific Question and its Answer(s), e.g. @@ -14,7 +14,7 @@ * @see http://schema.org/QAPage * */ -class QAPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class QAPage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/QuantitativeValue.php b/src/QuantitativeValue.php index 1e3bc1dc1..b1bc3ef86 100644 --- a/src/QuantitativeValue.php +++ b/src/QuantitativeValue.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/QuantitativeValue * */ -class QuantitativeValue extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class QuantitativeValue extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/QuantitativeValueDistribution.php b/src/QuantitativeValueDistribution.php index 626dbf4ee..9cd177209 100644 --- a/src/QuantitativeValueDistribution.php +++ b/src/QuantitativeValueDistribution.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/QuantitativeValueDistribution * */ -class QuantitativeValueDistribution extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class QuantitativeValueDistribution extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/QuoteAction.php b/src/QuoteAction.php index 543ec0de0..d77549c45 100644 --- a/src/QuoteAction.php +++ b/src/QuoteAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * An agent quotes/estimates/appraises an object/product/service with a price at @@ -13,7 +13,7 @@ * @see http://schema.org/QuoteAction * */ -class QuoteAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class QuoteAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/RadioEpisode.php b/src/RadioEpisode.php index 1acef7043..dd0e077a7 100644 --- a/src/RadioEpisode.php +++ b/src/RadioEpisode.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\EpisodeContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\EpisodeContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/RadioEpisode * */ -class RadioEpisode extends BaseType implements EpisodeContract, CreativeWorkContract, ThingContract +class RadioEpisode extends BaseType implements CreativeWorkContract, EpisodeContract, ThingContract { /** * The subject matter of the content. diff --git a/src/RadioSeason.php b/src/RadioSeason.php index 2a1943607..c7c19fed0 100644 --- a/src/RadioSeason.php +++ b/src/RadioSeason.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreativeWorkSeasonContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeasonContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/RadioSeason * */ -class RadioSeason extends BaseType implements CreativeWorkSeasonContract, CreativeWorkContract, ThingContract +class RadioSeason extends BaseType implements CreativeWorkContract, CreativeWorkSeasonContract, ThingContract { /** * The subject matter of the content. diff --git a/src/RadioSeries.php b/src/RadioSeries.php index 922b99ccf..c51849f89 100644 --- a/src/RadioSeries.php +++ b/src/RadioSeries.php @@ -2,11 +2,11 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * CreativeWorkSeries dedicated to radio broadcast and associated online @@ -15,7 +15,7 @@ * @see http://schema.org/RadioSeries * */ -class RadioSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract +class RadioSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, IntangibleContract, SeriesContract, ThingContract { /** * The subject matter of the content. diff --git a/src/ReactAction.php b/src/ReactAction.php index 87db9f670..e04bbe4b8 100644 --- a/src/ReactAction.php +++ b/src/ReactAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ReactAction * */ -class ReactAction extends BaseType implements AssessActionContract, ActionContract, ThingContract +class ReactAction extends BaseType implements ActionContract, AssessActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/ReadAction.php b/src/ReadAction.php index 7e75bf348..a06f6abfb 100644 --- a/src/ReadAction.php +++ b/src/ReadAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/ReadAction * */ -class ReadAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract +class ReadAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/ReceiveAction.php b/src/ReceiveAction.php index 51a14a6b7..a87b8c48d 100644 --- a/src/ReceiveAction.php +++ b/src/ReceiveAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TransferActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; /** * The act of physically/electronically taking delivery of an object thathas @@ -20,7 +20,7 @@ * @see http://schema.org/ReceiveAction * */ -class ReceiveAction extends BaseType implements TransferActionContract, ActionContract, ThingContract +class ReceiveAction extends BaseType implements ActionContract, ThingContract, TransferActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/Recipe.php b/src/Recipe.php index 4506612cfb..fd6531ad1 100644 --- a/src/Recipe.php +++ b/src/Recipe.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\HowToContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\HowToContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/Recipe * */ -class Recipe extends BaseType implements HowToContract, CreativeWorkContract, ThingContract +class Recipe extends BaseType implements CreativeWorkContract, HowToContract, ThingContract { /** * The subject matter of the content. diff --git a/src/RegisterAction.php b/src/RegisterAction.php index 4763fa40b..a2c4219dc 100644 --- a/src/RegisterAction.php +++ b/src/RegisterAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -21,7 +21,7 @@ * @see http://schema.org/RegisterAction * */ -class RegisterAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class RegisterAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/RejectAction.php b/src/RejectAction.php index 8455909a6..e970bbe5b 100644 --- a/src/RejectAction.php +++ b/src/RejectAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\AllocateActionContract; use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -17,7 +17,7 @@ * @see http://schema.org/RejectAction * */ -class RejectAction extends BaseType implements AllocateActionContract, OrganizeActionContract, ActionContract, ThingContract +class RejectAction extends BaseType implements ActionContract, AllocateActionContract, OrganizeActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/RentAction.php b/src/RentAction.php index 7c20b5799..3c0d11ff9 100644 --- a/src/RentAction.php +++ b/src/RentAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * The act of giving money in return for temporary use, but not ownership, of an @@ -14,7 +14,7 @@ * @see http://schema.org/RentAction * */ -class RentAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class RentAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/RentalCarReservation.php b/src/RentalCarReservation.php index 5e0897181..4320257c1 100644 --- a/src/RentalCarReservation.php +++ b/src/RentalCarReservation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/RentalCarReservation * */ -class RentalCarReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class RentalCarReservation extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/ReplaceAction.php b/src/ReplaceAction.php index 44715e079..6abae2909 100644 --- a/src/ReplaceAction.php +++ b/src/ReplaceAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UpdateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UpdateActionContract; /** * The act of editing a recipient by replacing an old object with a new object. @@ -12,7 +12,7 @@ * @see http://schema.org/ReplaceAction * */ -class ReplaceAction extends BaseType implements UpdateActionContract, ActionContract, ThingContract +class ReplaceAction extends BaseType implements ActionContract, ThingContract, UpdateActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/ReplyAction.php b/src/ReplyAction.php index 0b2e63190..3700050e4 100644 --- a/src/ReplyAction.php +++ b/src/ReplyAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -18,7 +18,7 @@ * @see http://schema.org/ReplyAction * */ -class ReplyAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class ReplyAction extends BaseType implements ActionContract, CommunicateActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/ReservationPackage.php b/src/ReservationPackage.php index 097f4fb8e..c98bad2d5 100644 --- a/src/ReservationPackage.php +++ b/src/ReservationPackage.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/ReservationPackage * */ -class ReservationPackage extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class ReservationPackage extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/ReserveAction.php b/src/ReserveAction.php index 247289976..a5ac9ba6a 100644 --- a/src/ReserveAction.php +++ b/src/ReserveAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlanActionContract; -use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\PlanActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -19,7 +19,7 @@ * @see http://schema.org/ReserveAction * */ -class ReserveAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract +class ReserveAction extends BaseType implements ActionContract, OrganizeActionContract, PlanActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/Resort.php b/src/Resort.php index 73a3c6b15..165f7d984 100644 --- a/src/Resort.php +++ b/src/Resort.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; +use \Spatie\SchemaOrg\Contracts\LodgingBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -21,7 +21,7 @@ * @see http://schema.org/Resort * */ -class Resort extends BaseType implements LodgingBusinessContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class Resort extends BaseType implements LocalBusinessContract, LodgingBusinessContract, OrganizationContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/ResumeAction.php b/src/ResumeAction.php index 7172bf638..fc3cb864e 100644 --- a/src/ResumeAction.php +++ b/src/ResumeAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ControlActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ControlActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ResumeAction * */ -class ResumeAction extends BaseType implements ControlActionContract, ActionContract, ThingContract +class ResumeAction extends BaseType implements ActionContract, ControlActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/ReturnAction.php b/src/ReturnAction.php index 2fb2746ec..59159be46 100644 --- a/src/ReturnAction.php +++ b/src/ReturnAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TransferActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; /** * The act of returning to the origin that which was previously received @@ -13,7 +13,7 @@ * @see http://schema.org/ReturnAction * */ -class ReturnAction extends BaseType implements TransferActionContract, ActionContract, ThingContract +class ReturnAction extends BaseType implements ActionContract, ThingContract, TransferActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/ReviewAction.php b/src/ReviewAction.php index dacf1951f..ac7a0c03b 100644 --- a/src/ReviewAction.php +++ b/src/ReviewAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ReviewAction * */ -class ReviewAction extends BaseType implements AssessActionContract, ActionContract, ThingContract +class ReviewAction extends BaseType implements ActionContract, AssessActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/RsvpAction.php b/src/RsvpAction.php index ab4ced288..db6a54765 100644 --- a/src/RsvpAction.php +++ b/src/RsvpAction.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InformActionContract; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; +use \Spatie\SchemaOrg\Contracts\InformActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -15,7 +15,7 @@ * @see http://schema.org/RsvpAction * */ -class RsvpAction extends BaseType implements InformActionContract, CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class RsvpAction extends BaseType implements ActionContract, CommunicateActionContract, InformActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/ScheduleAction.php b/src/ScheduleAction.php index 2e4e09459..975395d39 100644 --- a/src/ScheduleAction.php +++ b/src/ScheduleAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlanActionContract; -use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\OrganizeActionContract; +use \Spatie\SchemaOrg\Contracts\PlanActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -19,7 +19,7 @@ * @see http://schema.org/ScheduleAction * */ -class ScheduleAction extends BaseType implements PlanActionContract, OrganizeActionContract, ActionContract, ThingContract +class ScheduleAction extends BaseType implements ActionContract, OrganizeActionContract, PlanActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/SearchResultsPage.php b/src/SearchResultsPage.php index 2891fdae5..56cf87aed 100644 --- a/src/SearchResultsPage.php +++ b/src/SearchResultsPage.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * Web page type: Search results page. @@ -12,7 +12,7 @@ * @see http://schema.org/SearchResultsPage * */ -class SearchResultsPage extends BaseType implements WebPageContract, CreativeWorkContract, ThingContract +class SearchResultsPage extends BaseType implements CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/SellAction.php b/src/SellAction.php index 59a01f08e..99a9d9b02 100644 --- a/src/SellAction.php +++ b/src/SellAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * The act of taking money from a buyer in exchange for goods or services @@ -14,7 +14,7 @@ * @see http://schema.org/SellAction * */ -class SellAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class SellAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/SendAction.php b/src/SendAction.php index 72d99f862..0e016f255 100644 --- a/src/SendAction.php +++ b/src/SendAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TransferActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; /** * The act of physically/electronically dispatching an object for transfer from @@ -18,7 +18,7 @@ * @see http://schema.org/SendAction * */ -class SendAction extends BaseType implements TransferActionContract, ActionContract, ThingContract +class SendAction extends BaseType implements ActionContract, ThingContract, TransferActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/ShareAction.php b/src/ShareAction.php index 52f4c7eac..83b12c8ba 100644 --- a/src/ShareAction.php +++ b/src/ShareAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\CommunicateActionContract; use \Spatie\SchemaOrg\Contracts\InteractActionContract; -use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/ShareAction * */ -class ShareAction extends BaseType implements CommunicateActionContract, InteractActionContract, ActionContract, ThingContract +class ShareAction extends BaseType implements ActionContract, CommunicateActionContract, InteractActionContract, ThingContract { /** * The subject matter of the content. diff --git a/src/ShoeStore.php b/src/ShoeStore.php index 00d35eb1f..9bea266ee 100644 --- a/src/ShoeStore.php +++ b/src/ShoeStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/ShoeStore * */ -class ShoeStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class ShoeStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/SingleFamilyResidence.php b/src/SingleFamilyResidence.php index 3c9535f10..59c223f07 100644 --- a/src/SingleFamilyResidence.php +++ b/src/SingleFamilyResidence.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\HouseContract; use \Spatie\SchemaOrg\Contracts\AccommodationContract; +use \Spatie\SchemaOrg\Contracts\HouseContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; @@ -13,7 +13,7 @@ * @see http://schema.org/SingleFamilyResidence * */ -class SingleFamilyResidence extends BaseType implements HouseContract, AccommodationContract, PlaceContract, ThingContract +class SingleFamilyResidence extends BaseType implements AccommodationContract, HouseContract, PlaceContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/SiteNavigationElement.php b/src/SiteNavigationElement.php index 0bd178532..e61e1d604 100644 --- a/src/SiteNavigationElement.php +++ b/src/SiteNavigationElement.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageElementContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; /** * A navigation element of the page. @@ -14,7 +14,7 @@ * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ -class SiteNavigationElement extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract +class SiteNavigationElement extends BaseType implements CreativeWorkContract, ThingContract, WebPageElementContract { /** * The subject matter of the content. diff --git a/src/SkiResort.php b/src/SkiResort.php index 17d2b256e..8efe66f4c 100644 --- a/src/SkiResort.php +++ b/src/SkiResort.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/SkiResort * */ -class SkiResort extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class SkiResort extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/SportingGoodsStore.php b/src/SportingGoodsStore.php index bc1852251..b38f2e5b6 100644 --- a/src/SportingGoodsStore.php +++ b/src/SportingGoodsStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/SportingGoodsStore * */ -class SportingGoodsStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class SportingGoodsStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/SportsClub.php b/src/SportsClub.php index 733e6eb13..1796f1c3a 100644 --- a/src/SportsClub.php +++ b/src/SportsClub.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/SportsClub * */ -class SportsClub extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class SportsClub extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/SportsTeam.php b/src/SportsTeam.php index dfda2d731..f0ec2ebde 100644 --- a/src/SportsTeam.php +++ b/src/SportsTeam.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SportsOrganizationContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\SportsOrganizationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/SportsTeam * */ -class SportsTeam extends BaseType implements SportsOrganizationContract, OrganizationContract, ThingContract +class SportsTeam extends BaseType implements OrganizationContract, SportsOrganizationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/SpreadsheetDigitalDocument.php b/src/SpreadsheetDigitalDocument.php index 05c33dccd..01eb8e7cb 100644 --- a/src/SpreadsheetDigitalDocument.php +++ b/src/SpreadsheetDigitalDocument.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/SpreadsheetDigitalDocument * */ -class SpreadsheetDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract +class SpreadsheetDigitalDocument extends BaseType implements CreativeWorkContract, DigitalDocumentContract, ThingContract { /** * The subject matter of the content. diff --git a/src/StadiumOrArena.php b/src/StadiumOrArena.php index b42d77078..c84ab1e5a 100644 --- a/src/StadiumOrArena.php +++ b/src/StadiumOrArena.php @@ -3,11 +3,11 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; -use \Spatie\SchemaOrg\Contracts\PlaceContract; -use \Spatie\SchemaOrg\Contracts\ThingContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; /** * A stadium. @@ -15,7 +15,7 @@ * @see http://schema.org/StadiumOrArena * */ -class StadiumOrArena extends BaseType implements CivicStructureContract, SportsActivityLocationContract, PlaceContract, ThingContract, LocalBusinessContract, OrganizationContract +class StadiumOrArena extends BaseType implements CivicStructureContract, LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/SteeringPositionValue.php b/src/SteeringPositionValue.php index 4cd9c89a3..e29d357bf 100644 --- a/src/SteeringPositionValue.php +++ b/src/SteeringPositionValue.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; use \Spatie\SchemaOrg\Contracts\EnumerationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\QualitativeValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/SteeringPositionValue * */ -class SteeringPositionValue extends BaseType implements QualitativeValueContract, EnumerationContract, IntangibleContract, ThingContract +class SteeringPositionValue extends BaseType implements EnumerationContract, IntangibleContract, QualitativeValueContract, ThingContract { /** * The steering position is on the left side of the vehicle (viewed from the diff --git a/src/SubscribeAction.php b/src/SubscribeAction.php index 9af187da9..e8beab948 100644 --- a/src/SubscribeAction.php +++ b/src/SubscribeAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -23,7 +23,7 @@ * @see http://schema.org/SubscribeAction * */ -class SubscribeAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class SubscribeAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/SuspendAction.php b/src/SuspendAction.php index 27e129d68..fa263f53c 100644 --- a/src/SuspendAction.php +++ b/src/SuspendAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ControlActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ControlActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/SuspendAction * */ -class SuspendAction extends BaseType implements ControlActionContract, ActionContract, ThingContract +class SuspendAction extends BaseType implements ActionContract, ControlActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/Synagogue.php b/src/Synagogue.php index 49e1529eb..ee1e91a43 100644 --- a/src/Synagogue.php +++ b/src/Synagogue.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\CivicStructureContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\PlaceOfWorshipContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/Synagogue * */ -class Synagogue extends BaseType implements PlaceOfWorshipContract, CivicStructureContract, PlaceContract, ThingContract +class Synagogue extends BaseType implements CivicStructureContract, PlaceContract, PlaceOfWorshipContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/TVEpisode.php b/src/TVEpisode.php index fbfcd0249..7abc78e43 100644 --- a/src/TVEpisode.php +++ b/src/TVEpisode.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\EpisodeContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\EpisodeContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/TVEpisode * */ -class TVEpisode extends BaseType implements EpisodeContract, CreativeWorkContract, ThingContract +class TVEpisode extends BaseType implements CreativeWorkContract, EpisodeContract, ThingContract { /** * The subject matter of the content. diff --git a/src/TVSeries.php b/src/TVSeries.php index 7fe57089c..cb4fcf436 100644 --- a/src/TVSeries.php +++ b/src/TVSeries.php @@ -4,9 +4,9 @@ use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; -use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\SeriesContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\SeriesContract; +use \Spatie\SchemaOrg\Contracts\ThingContract; /** * CreativeWorkSeries dedicated to TV broadcast and associated online delivery. @@ -14,7 +14,7 @@ * @see http://schema.org/TVSeries * */ -class TVSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, ThingContract, SeriesContract, IntangibleContract +class TVSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, IntangibleContract, SeriesContract, ThingContract { /** * The subject matter of the content. diff --git a/src/Table.php b/src/Table.php index cc542efd2..b1125e2a2 100644 --- a/src/Table.php +++ b/src/Table.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageElementContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; /** * A table on a Web page. @@ -14,7 +14,7 @@ * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ -class Table extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract +class Table extends BaseType implements CreativeWorkContract, ThingContract, WebPageElementContract { /** * The subject matter of the content. diff --git a/src/TakeAction.php b/src/TakeAction.php index f409e5501..3f4a1836d 100644 --- a/src/TakeAction.php +++ b/src/TakeAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TransferActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TransferActionContract; /** * The act of gaining ownership of an object from an origin. Reciprocal of @@ -19,7 +19,7 @@ * @see http://schema.org/TakeAction * */ -class TakeAction extends BaseType implements TransferActionContract, ActionContract, ThingContract +class TakeAction extends BaseType implements ActionContract, ThingContract, TransferActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/Taxi.php b/src/Taxi.php index 4f26bb203..396e6733d 100644 --- a/src/Taxi.php +++ b/src/Taxi.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/Taxi * */ -class Taxi extends BaseType implements ServiceContract, IntangibleContract, ThingContract +class Taxi extends BaseType implements IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/TaxiReservation.php b/src/TaxiReservation.php index c1ce58a7f..05218e3ff 100644 --- a/src/TaxiReservation.php +++ b/src/TaxiReservation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/TaxiReservation * */ -class TaxiReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class TaxiReservation extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/TaxiService.php b/src/TaxiService.php index 13e3afbe1..f10386126 100644 --- a/src/TaxiService.php +++ b/src/TaxiService.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ServiceContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/TaxiService * */ -class TaxiService extends BaseType implements ServiceContract, IntangibleContract, ThingContract +class TaxiService extends BaseType implements IntangibleContract, ServiceContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/TennisComplex.php b/src/TennisComplex.php index 0e016c093..c1f76274f 100644 --- a/src/TennisComplex.php +++ b/src/TennisComplex.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\SportsActivityLocationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/TennisComplex * */ -class TennisComplex extends BaseType implements SportsActivityLocationContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class TennisComplex extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, SportsActivityLocationContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/TextDigitalDocument.php b/src/TextDigitalDocument.php index 2d63804c2..50d595365 100644 --- a/src/TextDigitalDocument.php +++ b/src/TextDigitalDocument.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\DigitalDocumentContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/TextDigitalDocument * */ -class TextDigitalDocument extends BaseType implements DigitalDocumentContract, CreativeWorkContract, ThingContract +class TextDigitalDocument extends BaseType implements CreativeWorkContract, DigitalDocumentContract, ThingContract { /** * The subject matter of the content. diff --git a/src/TheaterGroup.php b/src/TheaterGroup.php index d83dca87c..b336d3d51 100644 --- a/src/TheaterGroup.php +++ b/src/TheaterGroup.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; +use \Spatie\SchemaOrg\Contracts\PerformingGroupContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/TheaterGroup * */ -class TheaterGroup extends BaseType implements PerformingGroupContract, OrganizationContract, ThingContract +class TheaterGroup extends BaseType implements OrganizationContract, PerformingGroupContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/TipAction.php b/src/TipAction.php index eb1185362..d830b1957 100644 --- a/src/TipAction.php +++ b/src/TipAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TradeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TradeActionContract; /** * The act of giving money voluntarily to a beneficiary in recognition of @@ -13,7 +13,7 @@ * @see http://schema.org/TipAction * */ -class TipAction extends BaseType implements TradeActionContract, ActionContract, ThingContract +class TipAction extends BaseType implements ActionContract, ThingContract, TradeActionContract { /** * Indicates the current disposition of the Action. diff --git a/src/TireShop.php b/src/TireShop.php index 377315d22..84cabb5f8 100644 --- a/src/TireShop.php +++ b/src/TireShop.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/TireShop * */ -class TireShop extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class TireShop extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/ToyStore.php b/src/ToyStore.php index 687512d77..ab02e0633 100644 --- a/src/ToyStore.php +++ b/src/ToyStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/ToyStore * */ -class ToyStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class ToyStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/TrackAction.php b/src/TrackAction.php index 14407e842..1cf8d2169 100644 --- a/src/TrackAction.php +++ b/src/TrackAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\FindActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\FindActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -19,7 +19,7 @@ * @see http://schema.org/TrackAction * */ -class TrackAction extends BaseType implements FindActionContract, ActionContract, ThingContract +class TrackAction extends BaseType implements ActionContract, FindActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/TrainReservation.php b/src/TrainReservation.php index 424933ef9..65da930b8 100644 --- a/src/TrainReservation.php +++ b/src/TrainReservation.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\ReservationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -16,7 +16,7 @@ * @see http://schema.org/TrainReservation * */ -class TrainReservation extends BaseType implements ReservationContract, IntangibleContract, ThingContract +class TrainReservation extends BaseType implements IntangibleContract, ReservationContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/TrainTrip.php b/src/TrainTrip.php index db7bdf8d7..9aa2b2d4f 100644 --- a/src/TrainTrip.php +++ b/src/TrainTrip.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\TripContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\TripContract; /** * A trip on a commercial train line. @@ -12,7 +12,7 @@ * @see http://schema.org/TrainTrip * */ -class TrainTrip extends BaseType implements TripContract, IntangibleContract, ThingContract +class TrainTrip extends BaseType implements IntangibleContract, ThingContract, TripContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/TravelAction.php b/src/TravelAction.php index e3b895145..fe91ba333 100644 --- a/src/TravelAction.php +++ b/src/TravelAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MoveActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\MoveActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/TravelAction * */ -class TravelAction extends BaseType implements MoveActionContract, ActionContract, ThingContract +class TravelAction extends BaseType implements ActionContract, MoveActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/TypeAndQuantityNode.php b/src/TypeAndQuantityNode.php index d411d7165..3788b3d8c 100644 --- a/src/TypeAndQuantityNode.php +++ b/src/TypeAndQuantityNode.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/TypeAndQuantityNode * */ -class TypeAndQuantityNode extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class TypeAndQuantityNode extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/UnRegisterAction.php b/src/UnRegisterAction.php index 89bab0a21..902b787f1 100644 --- a/src/UnRegisterAction.php +++ b/src/UnRegisterAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\InteractActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -19,7 +19,7 @@ * @see http://schema.org/UnRegisterAction * */ -class UnRegisterAction extends BaseType implements InteractActionContract, ActionContract, ThingContract +class UnRegisterAction extends BaseType implements ActionContract, InteractActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/UnitPriceSpecification.php b/src/UnitPriceSpecification.php index 9f083fc7e..6b5472dda 100644 --- a/src/UnitPriceSpecification.php +++ b/src/UnitPriceSpecification.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\PriceSpecificationContract; use \Spatie\SchemaOrg\Contracts\StructuredValueContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/UnitPriceSpecification * */ -class UnitPriceSpecification extends BaseType implements PriceSpecificationContract, StructuredValueContract, IntangibleContract, ThingContract +class UnitPriceSpecification extends BaseType implements IntangibleContract, PriceSpecificationContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/UseAction.php b/src/UseAction.php index a2ea79199..71bf2495b 100644 --- a/src/UseAction.php +++ b/src/UseAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/UseAction * */ -class UseAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract +class UseAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/UserBlocks.php b/src/UserBlocks.php index 4528306fe..1e93ed82b 100644 --- a/src/UserBlocks.php +++ b/src/UserBlocks.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserBlocks * */ -class UserBlocks extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserBlocks extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/UserCheckins.php b/src/UserCheckins.php index 34358c8b9..05c8b81dc 100644 --- a/src/UserCheckins.php +++ b/src/UserCheckins.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserCheckins * */ -class UserCheckins extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserCheckins extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/UserComments.php b/src/UserComments.php index 577a8d451..bf48f798a 100644 --- a/src/UserComments.php +++ b/src/UserComments.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserComments * */ -class UserComments extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserComments extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/UserDownloads.php b/src/UserDownloads.php index 76c0911e7..7435d175b 100644 --- a/src/UserDownloads.php +++ b/src/UserDownloads.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserDownloads * */ -class UserDownloads extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserDownloads extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/UserLikes.php b/src/UserLikes.php index c5bc826ef..d6b4fa160 100644 --- a/src/UserLikes.php +++ b/src/UserLikes.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserLikes * */ -class UserLikes extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserLikes extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/UserPageVisits.php b/src/UserPageVisits.php index 819fe9c4f..12b06b882 100644 --- a/src/UserPageVisits.php +++ b/src/UserPageVisits.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserPageVisits * */ -class UserPageVisits extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserPageVisits extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/UserPlays.php b/src/UserPlays.php index 6ebccf71d..651a9ab6d 100644 --- a/src/UserPlays.php +++ b/src/UserPlays.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserPlays * */ -class UserPlays extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserPlays extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/UserPlusOnes.php b/src/UserPlusOnes.php index 8bd98b1ab..286b85585 100644 --- a/src/UserPlusOnes.php +++ b/src/UserPlusOnes.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserPlusOnes * */ -class UserPlusOnes extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserPlusOnes extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/UserTweets.php b/src/UserTweets.php index 0ab473a43..a7e68eee1 100644 --- a/src/UserTweets.php +++ b/src/UserTweets.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UserInteractionContract; use \Spatie\SchemaOrg\Contracts\EventContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UserInteractionContract; /** * UserInteraction and its subtypes is an old way of talking about users @@ -14,7 +14,7 @@ * @see http://schema.org/UserTweets * */ -class UserTweets extends BaseType implements UserInteractionContract, EventContract, ThingContract +class UserTweets extends BaseType implements EventContract, ThingContract, UserInteractionContract { /** * The subject matter of the content. diff --git a/src/VideoGallery.php b/src/VideoGallery.php index b6faf5958..29cde375c 100644 --- a/src/VideoGallery.php +++ b/src/VideoGallery.php @@ -3,9 +3,9 @@ namespace Spatie\SchemaOrg; use \Spatie\SchemaOrg\Contracts\CollectionPageContract; -use \Spatie\SchemaOrg\Contracts\WebPageContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageContract; /** * Web page type: Video gallery page. @@ -13,7 +13,7 @@ * @see http://schema.org/VideoGallery * */ -class VideoGallery extends BaseType implements CollectionPageContract, WebPageContract, CreativeWorkContract, ThingContract +class VideoGallery extends BaseType implements CollectionPageContract, CreativeWorkContract, ThingContract, WebPageContract { /** * The subject matter of the content. diff --git a/src/VideoGame.php b/src/VideoGame.php index ef67d1e6e..3469566ff 100644 --- a/src/VideoGame.php +++ b/src/VideoGame.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; -use \Spatie\SchemaOrg\Contracts\GameContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\GameContract; +use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/VideoGame * */ -class VideoGame extends BaseType implements SoftwareApplicationContract, GameContract, CreativeWorkContract, ThingContract +class VideoGame extends BaseType implements CreativeWorkContract, GameContract, SoftwareApplicationContract, ThingContract { /** * The subject matter of the content. diff --git a/src/VideoGameSeries.php b/src/VideoGameSeries.php index 2f48a4cb3..b77c9a0f8 100644 --- a/src/VideoGameSeries.php +++ b/src/VideoGameSeries.php @@ -2,11 +2,11 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\CreativeWorkSeriesContract; +use \Spatie\SchemaOrg\Contracts\IntangibleContract; use \Spatie\SchemaOrg\Contracts\SeriesContract; use \Spatie\SchemaOrg\Contracts\ThingContract; -use \Spatie\SchemaOrg\Contracts\IntangibleContract; /** * A video game series. @@ -14,7 +14,7 @@ * @see http://schema.org/VideoGameSeries * */ -class VideoGameSeries extends BaseType implements CreativeWorkSeriesContract, CreativeWorkContract, SeriesContract, ThingContract, IntangibleContract +class VideoGameSeries extends BaseType implements CreativeWorkContract, CreativeWorkSeriesContract, IntangibleContract, SeriesContract, ThingContract { /** * The subject matter of the content. diff --git a/src/VideoObject.php b/src/VideoObject.php index cc2b8603d..2caebb09f 100644 --- a/src/VideoObject.php +++ b/src/VideoObject.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\MediaObjectContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/VideoObject * */ -class VideoObject extends BaseType implements MediaObjectContract, CreativeWorkContract, ThingContract +class VideoObject extends BaseType implements CreativeWorkContract, MediaObjectContract, ThingContract { /** * The subject matter of the content. diff --git a/src/ViewAction.php b/src/ViewAction.php index 739022a0b..720dd08d4 100644 --- a/src/ViewAction.php +++ b/src/ViewAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/ViewAction * */ -class ViewAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract +class ViewAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/VoteAction.php b/src/VoteAction.php index 6fbe06f73..d0fe78935 100644 --- a/src/VoteAction.php +++ b/src/VoteAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ChooseActionContract; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ChooseActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/VoteAction * */ -class VoteAction extends BaseType implements ChooseActionContract, AssessActionContract, ActionContract, ThingContract +class VoteAction extends BaseType implements ActionContract, AssessActionContract, ChooseActionContract, ThingContract { /** * A sub property of object. The options subject to this action. diff --git a/src/WPAdBlock.php b/src/WPAdBlock.php index 0006072fd..407ca3049 100644 --- a/src/WPAdBlock.php +++ b/src/WPAdBlock.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageElementContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; /** * An advertising section of the page. @@ -14,7 +14,7 @@ * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ -class WPAdBlock extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract +class WPAdBlock extends BaseType implements CreativeWorkContract, ThingContract, WebPageElementContract { /** * The subject matter of the content. diff --git a/src/WPFooter.php b/src/WPFooter.php index 7a3264894..f62f2bed7 100644 --- a/src/WPFooter.php +++ b/src/WPFooter.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageElementContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; /** * The footer section of the page. @@ -14,7 +14,7 @@ * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ -class WPFooter extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract +class WPFooter extends BaseType implements CreativeWorkContract, ThingContract, WebPageElementContract { /** * The subject matter of the content. diff --git a/src/WPHeader.php b/src/WPHeader.php index b4afe852f..3ed8d64cd 100644 --- a/src/WPHeader.php +++ b/src/WPHeader.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageElementContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; /** * The header section of the page. @@ -14,7 +14,7 @@ * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ -class WPHeader extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract +class WPHeader extends BaseType implements CreativeWorkContract, ThingContract, WebPageElementContract { /** * The subject matter of the content. diff --git a/src/WPSideBar.php b/src/WPSideBar.php index b35f63484..09ec8c202 100644 --- a/src/WPSideBar.php +++ b/src/WPSideBar.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\WebPageElementContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\WebPageElementContract; /** * A sidebar section of the page. @@ -14,7 +14,7 @@ * @method static cssSelector($cssSelector) The value should be instance of pending types CssSelectorType|CssSelectorType[] * @method static xpath($xpath) The value should be instance of pending types XPathType|XPathType[] */ -class WPSideBar extends BaseType implements WebPageElementContract, CreativeWorkContract, ThingContract +class WPSideBar extends BaseType implements CreativeWorkContract, ThingContract, WebPageElementContract { /** * The subject matter of the content. diff --git a/src/WantAction.php b/src/WantAction.php index 45b223ebe..144a9503b 100644 --- a/src/WantAction.php +++ b/src/WantAction.php @@ -2,9 +2,9 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ReactActionContract; -use \Spatie\SchemaOrg\Contracts\AssessActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\AssessActionContract; +use \Spatie\SchemaOrg\Contracts\ReactActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -13,7 +13,7 @@ * @see http://schema.org/WantAction * */ -class WantAction extends BaseType implements ReactActionContract, AssessActionContract, ActionContract, ThingContract +class WantAction extends BaseType implements ActionContract, AssessActionContract, ReactActionContract, ThingContract { /** * Indicates the current disposition of the Action. diff --git a/src/WarrantyPromise.php b/src/WarrantyPromise.php index db707c672..036b41c78 100644 --- a/src/WarrantyPromise.php +++ b/src/WarrantyPromise.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\IntangibleContract; +use \Spatie\SchemaOrg\Contracts\StructuredValueContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/WarrantyPromise * */ -class WarrantyPromise extends BaseType implements StructuredValueContract, IntangibleContract, ThingContract +class WarrantyPromise extends BaseType implements IntangibleContract, StructuredValueContract, ThingContract { /** * An additional type for the item, typically used for adding more specific diff --git a/src/WatchAction.php b/src/WatchAction.php index b5a861cbf..97dd66746 100644 --- a/src/WatchAction.php +++ b/src/WatchAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/WatchAction * */ -class WatchAction extends BaseType implements ConsumeActionContract, ActionContract, ThingContract +class WatchAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/WearAction.php b/src/WearAction.php index 2dc1d90e8..b9e86729d 100644 --- a/src/WearAction.php +++ b/src/WearAction.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\UseActionContract; -use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\ConsumeActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; +use \Spatie\SchemaOrg\Contracts\UseActionContract; /** * The act of dressing oneself in clothing. @@ -13,7 +13,7 @@ * @see http://schema.org/WearAction * */ -class WearAction extends BaseType implements UseActionContract, ConsumeActionContract, ActionContract, ThingContract +class WearAction extends BaseType implements ActionContract, ConsumeActionContract, ThingContract, UseActionContract { /** * A set of requirements that a must be fulfilled in order to perform an diff --git a/src/WebApplication.php b/src/WebApplication.php index 6dc0bff2a..a9b204511 100644 --- a/src/WebApplication.php +++ b/src/WebApplication.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; use \Spatie\SchemaOrg\Contracts\CreativeWorkContract; +use \Spatie\SchemaOrg\Contracts\SoftwareApplicationContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/WebApplication * */ -class WebApplication extends BaseType implements SoftwareApplicationContract, CreativeWorkContract, ThingContract +class WebApplication extends BaseType implements CreativeWorkContract, SoftwareApplicationContract, ThingContract { /** * The subject matter of the content. diff --git a/src/WholesaleStore.php b/src/WholesaleStore.php index d60c7cea3..69ff86e42 100644 --- a/src/WholesaleStore.php +++ b/src/WholesaleStore.php @@ -2,10 +2,10 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\LocalBusinessContract; use \Spatie\SchemaOrg\Contracts\OrganizationContract; use \Spatie\SchemaOrg\Contracts\PlaceContract; +use \Spatie\SchemaOrg\Contracts\StoreContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -14,7 +14,7 @@ * @see http://schema.org/WholesaleStore * */ -class WholesaleStore extends BaseType implements StoreContract, LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract +class WholesaleStore extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, StoreContract, ThingContract { /** * A property-value pair representing an additional characteristics of the diff --git a/src/WriteAction.php b/src/WriteAction.php index 6a77e58d2..e1a63efdc 100644 --- a/src/WriteAction.php +++ b/src/WriteAction.php @@ -2,8 +2,8 @@ namespace Spatie\SchemaOrg; -use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ActionContract; +use \Spatie\SchemaOrg\Contracts\CreateActionContract; use \Spatie\SchemaOrg\Contracts\ThingContract; /** @@ -12,7 +12,7 @@ * @see http://schema.org/WriteAction * */ -class WriteAction extends BaseType implements CreateActionContract, ActionContract, ThingContract +class WriteAction extends BaseType implements ActionContract, CreateActionContract, ThingContract { /** * Indicates the current disposition of the Action. From d0ad4a9b9e30162c83a9c22de26fad07dfab1f9a Mon Sep 17 00:00:00 2001 From: Gummibeer Date: Wed, 25 Sep 2019 15:36:57 +0200 Subject: [PATCH 13/13] do not change variable type on runtime --- generator/Type.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/generator/Type.php b/generator/Type.php index 1f1e2748a..fe8763fac 100644 --- a/generator/Type.php +++ b/generator/Type.php @@ -53,13 +53,13 @@ public function setTypeCollection(TypeCollection $typeCollection): void $types = $typeCollection->toArray(); - foreach ($this->parents as $parent) { - if (! isset($types[$parent])) { + foreach ($this->parents as $parentType) { + if (! isset($types[$parentType])) { continue; } /** @var Type $parent */ - $parent = $types[$parent]; + $parent = $types[$parentType]; $parent->setTypeCollection($typeCollection); $this->parents = array_unique(array_merge($this->parents, $parent->parents));